Input indexInput detailsOutput indexOutput details

pcmOpCustModifyCustomer

Componentfm_cust
Visibilitypublic
Transactionrequired


Description

The pcmOpCustModifyCustomer operation can be used to modify customer information. This operations helps to add account and service level deals, add new services and purchase deals to those services and also to add and/or update balance groups, billinfo's, payinfo's and profiles.


Input field index

0poidPOID
0poidACCOUNT_OBJ
0timestampEND_T
0timestampSTART_T
0stringPROGRAM_NAME
0arrayACCTINFO
1poid      DEAL_OBJ
1substruct      DEAL_INFO
2string           NAME
2string           DESCR
2timestamp           START_T
2timestamp           END_T
2int           FLAGS
2array           PRODUCTS
3poid                PRODUCT_OBJ
3poid                PLAN_OBJ
3decimal                QUANTITY
3enum                STATUS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3decimal                PURCHASE_DISCOUNT
3decimal                PURCHASE_DISC_AMT
3decimal                PURCHASE_FEE_AMT
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3decimal                CYCLE_DISCOUNT
3decimal                CYCLE_DISC_AMT
3decimal                CYCLE_FEE_AMT
3int                STATUS_FLAGS
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3decimal                USAGE_DISCOUNT
3string                DESCR
3string                PRICE_LIST_NAME
2array           DISCOUNTS
3poid                DISCOUNT_OBJ
3poid                PLAN_OBJ
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3string                DESCR
2array           PERMITTEDS
3string                OBJ_TYPE
1array      BAL_INFO
2poid           POID
2string           NAME
2array           BILLINFO
3poid                POID
3poid                BUSINESS_PROFILE_OBJ
3string                BILLINFO_ID
3array                PAYINFO
4poid                     POID
4enum                     PAY_TYPE
4enum                     PAYMENT_TERM
4int                     PAYMENT_OFFSET
4string                     NAME
4enum                     INV_TYPE
4int                     FLAGS
4substruct                     INHERITED_INFO
5array                          INV_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DELIVERY_DESCR
6enum                               DELIVERY_PREFER
6string                               INV_INSTR
6enum                               INV_TERMS
6string                               EMAIL_ADDR
6string                               NAME
6string                               STATE
6string                               ZIP
5array                          CC_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_EXP
6string                               DEBIT_NUM
6string                               NAME
6string                               SECURITY_ID
6string                               STATE
6string                               ZIP
5array                          DD_INFO
6string                               ADDRESS
6string                               BANK_NO
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_NUM
6string                               NAME
6string                               STATE
6enum                               TYPE
6string                               ZIP
5array                          SEPA_INFO
6enum                               MANDATE_TYPE
6string                               IBAN
6string                               BIC
6string                               MANDATE_CONTRACT_ID
6string                               MANDATE_CONTRACT_DESCR
6string                               MANDATE_UNIQUE_REFERENCE
6timestamp                               MANDATE_SIGNED_T
6string                               MANDATE_SIGNED_PLACE
6array                               DEBTOR_INFO
7string                                    ADDRESS
7string                                    CITY
7string                                    COUNTRY
7string                                    NAME
7string                                    ZIP
7string                                    IDENTIFICATION_CODE
7string                                    REF_PARTY
7string                                    REF_PARTY_ID_CODE
6string                               CREDITOR_ID
6string                               CREDITOR_NAME
3array                BAL_INFO
3enum                PAY_TYPE
3int                PARENT_FLAGS
3int                BILL_WHEN
3int                ACTG_FUTURE_DOM
3enum                ACTG_TYPE
3enum                BILLING_STATUS
3int                BILLING_STATUS_FLAGS
3enum                STATUS
3int                STATUS_FLAGS
3int                SPONSOR_FLAGS
3int                SPONSOREE_FLAGS
3poid                AR_BILLINFO_OBJ
3poid                PARENT_BILLINFO_OBJ
3int                CURRENCY
3int                CURRENCY_SECONDARY
3enum                BILLING_SEGMENT
2poid           BILLINFO_OBJ
2array           LIMIT
3decimal                CREDIT_LIMIT
3decimal                CREDIT_FLOOR
3decimal                CREDIT_THRESHOLDS_FIXED
3int                CREDIT_THRESHOLDS
3array                THRESHOLDS
4int                     THRESHOLD
4decimal                     AMOUNT
2array           RULES
3enum                CONSUMPTION_RULE
1poid      BAL_GRP_OBJ
1int      CURRENCY
1int      CURRENCY_SECONDARY
0arraySERVICES
1poid      SERVICE_OBJ
1int      SUBSCRIPTION_INDEX
1poid      SUBSCRIPTION_OBJ
1string      SERVICE_ID
1array      BAL_INFO
2poid           POID
2string           NAME
2array           BILLINFO
3poid                POID
3poid                BUSINESS_PROFILE_OBJ
3string                BILLINFO_ID
3array                PAYINFO
4poid                     POID
4enum                     PAY_TYPE
4enum                     PAYMENT_TERM
4int                     PAYMENT_OFFSET
4string                     NAME
4enum                     INV_TYPE
4int                     FLAGS
4substruct                     INHERITED_INFO
5array                          INV_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DELIVERY_DESCR
6enum                               DELIVERY_PREFER
6string                               INV_INSTR
6enum                               INV_TERMS
6string                               EMAIL_ADDR
6string                               NAME
6string                               STATE
6string                               ZIP
5array                          CC_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_EXP
6string                               DEBIT_NUM
6string                               NAME
6string                               SECURITY_ID
6string                               STATE
6string                               ZIP
5array                          DD_INFO
6string                               ADDRESS
6string                               BANK_NO
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_NUM
6string                               NAME
6string                               STATE
6enum                               TYPE
6string                               ZIP
5array                          SEPA_INFO
6enum                               MANDATE_TYPE
6string                               IBAN
6string                               BIC
6string                               MANDATE_CONTRACT_ID
6string                               MANDATE_CONTRACT_DESCR
6string                               MANDATE_UNIQUE_REFERENCE
6timestamp                               MANDATE_SIGNED_T
6string                               MANDATE_SIGNED_PLACE
6array                               DEBTOR_INFO
7string                                    ADDRESS
7string                                    CITY
7string                                    COUNTRY
7string                                    NAME
7string                                    ZIP
7string                                    IDENTIFICATION_CODE
7string                                    REF_PARTY
7string                                    REF_PARTY_ID_CODE
6string                               CREDITOR_ID
6string                               CREDITOR_NAME
3array                BAL_INFO
3enum                PAY_TYPE
3int                PARENT_FLAGS
3int                BILL_WHEN
3int                ACTG_FUTURE_DOM
3enum                ACTG_TYPE
3enum                BILLING_STATUS
3int                BILLING_STATUS_FLAGS
3enum                STATUS
3int                STATUS_FLAGS
3int                SPONSOR_FLAGS
3int                SPONSOREE_FLAGS
3poid                AR_BILLINFO_OBJ
3poid                PARENT_BILLINFO_OBJ
3int                CURRENCY
3int                CURRENCY_SECONDARY
3enum                BILLING_SEGMENT
2poid           BILLINFO_OBJ
2array           LIMIT
3decimal                CREDIT_LIMIT
3decimal                CREDIT_FLOOR
3decimal                CREDIT_THRESHOLDS_FIXED
3int                CREDIT_THRESHOLDS
3array                THRESHOLDS
4int                     THRESHOLD
4decimal                     AMOUNT
2array           RULES
3enum                CONSUMPTION_RULE
1poid      BAL_GRP_OBJ
1string      LOGIN
1array      ALIAS_LIST
2string           NAME
1string      PASSWD_CLEAR
1enum      PASSWD_STATUS
1poid      DEAL_OBJ
1substruct      DEAL_INFO
2string           NAME
2string           DESCR
2timestamp           START_T
2timestamp           END_T
2int           FLAGS
2array           PRODUCTS
3poid                PRODUCT_OBJ
3poid                PLAN_OBJ
3decimal                QUANTITY
3enum                STATUS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3decimal                PURCHASE_DISCOUNT
3decimal                PURCHASE_DISC_AMT
3decimal                PURCHASE_FEE_AMT
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3decimal                CYCLE_DISCOUNT
3decimal                CYCLE_DISC_AMT
3decimal                CYCLE_FEE_AMT
3int                STATUS_FLAGS
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3decimal                USAGE_DISCOUNT
3string                DESCR
3string                PRICE_LIST_NAME
2array           DISCOUNTS
3poid                DISCOUNT_OBJ
3poid                PLAN_OBJ
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3string                DESCR
2array           PERMITTEDS
3string                OBJ_TYPE
1array      DEALS
2poid           DEAL_OBJ
2enum           TYPE
2substruct           DEAL_INFO
3string                NAME
3string                DESCR
3timestamp                START_T
3timestamp                END_T
3int                FLAGS
3array                PRODUCTS
4poid                     PRODUCT_OBJ
4poid                     PLAN_OBJ
4decimal                     QUANTITY
4enum                     STATUS
4timestamp                     PURCHASE_START_T
4int                     PURCHASE_START_UNIT
4int                     PURCHASE_START_OFFSET
4timestamp                     PURCHASE_END_T
4int                     PURCHASE_END_UNIT
4int                     PURCHASE_END_OFFSET
4decimal                     PURCHASE_DISCOUNT
4decimal                     PURCHASE_DISC_AMT
4decimal                     PURCHASE_FEE_AMT
4timestamp                     CYCLE_START_T
4int                     CYCLE_START_UNIT
4int                     CYCLE_START_OFFSET
4timestamp                     CYCLE_END_T
4int                     CYCLE_END_UNIT
4int                     CYCLE_END_OFFSET
4decimal                     CYCLE_DISCOUNT
4decimal                     CYCLE_DISC_AMT
4decimal                     CYCLE_FEE_AMT
4int                     STATUS_FLAGS
4timestamp                     USAGE_START_T
4int                     USAGE_START_UNIT
4int                     USAGE_START_OFFSET
4timestamp                     USAGE_END_T
4int                     USAGE_END_UNIT
4int                     USAGE_END_OFFSET
4decimal                     USAGE_DISCOUNT
4string                     DESCR
3array                DISCOUNTS
4poid                     DISCOUNT_OBJ
4poid                     PLAN_OBJ
4decimal                     QUANTITY
4enum                     STATUS
4int                     STATUS_FLAGS
4timestamp                     PURCHASE_START_T
4int                     PURCHASE_START_UNIT
4int                     PURCHASE_START_OFFSET
4timestamp                     PURCHASE_END_T
4int                     PURCHASE_END_UNIT
4int                     PURCHASE_END_OFFSET
4timestamp                     CYCLE_START_T
4int                     CYCLE_START_UNIT
4int                     CYCLE_START_OFFSET
4timestamp                     CYCLE_END_T
4int                     CYCLE_END_UNIT
4int                     CYCLE_END_OFFSET
4timestamp                     USAGE_START_T
4int                     USAGE_START_UNIT
4int                     USAGE_START_OFFSET
4timestamp                     USAGE_END_T
4int                     USAGE_END_UNIT
4int                     USAGE_END_OFFSET
4string                     DESCR
3array                PERMITTEDS
4string                     OBJ_TYPE
1array      STATUSES
2enum           STATUS
2int           STATUS_FLAGS
2timestamp           CLOSE_WHEN_T
1array      PROFILES
2poid           PROFILE_OBJ
2substruct           INHERITED_INFO
1substruct      INHERITED_INFO
1array      DEVICES
2poid           DEVICE_OBJ
0arrayBILLINFO
1poid      POID
1poid      BUSINESS_PROFILE_OBJ
1string      BILLINFO_ID
1int      ACTG_CYCLE_DOM
1array      PAYINFO
2poid           POID
2enum           PAY_TYPE
2enum           PAYMENT_TERM
2int           PAYMENT_OFFSET
2string           NAME
2enum           INV_TYPE
2int           FLAGS
2substruct           INHERITED_INFO
3array                INV_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DELIVERY_DESCR
4enum                     DELIVERY_PREFER
4string                     INV_INSTR
4enum                     INV_TERMS
4string                     EMAIL_ADDR
4string                     NAME
4string                     STATE
4string                     ZIP
3array                CC_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_EXP
4string                     DEBIT_NUM
4string                     NAME
4string                     SECURITY_ID
4string                     STATE
4string                     ZIP
3array                DD_INFO
4string                     ADDRESS
4string                     BANK_NO
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_NUM
4string                     NAME
4string                     STATE
4enum                     TYPE
4string                     ZIP
3array                SEPA_INFO
4enum                     MANDATE_TYPE
4string                     IBAN
4string                     BIC
4string                     MANDATE_CONTRACT_ID
4string                     MANDATE_CONTRACT_DESCR
4string                     MANDATE_UNIQUE_REFERENCE
4timestamp                     MANDATE_SIGNED_T
4string                     MANDATE_SIGNED_PLACE
4array                     DEBTOR_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          NAME
5string                          ZIP
5string                          IDENTIFICATION_CODE
5string                          REF_PARTY
5string                          REF_PARTY_ID_CODE
4string                     CREDITOR_ID
4string                     CREDITOR_NAME
1array      BAL_INFO
2poid           POID
2string           NAME
2array           BILLINFO
2poid           BILLINFO_OBJ
2array           LIMIT
3decimal                CREDIT_LIMIT
3decimal                CREDIT_FLOOR
3decimal                CREDIT_THRESHOLDS_FIXED
3int                CREDIT_THRESHOLDS
3array                THRESHOLDS
4int                     THRESHOLD
4decimal                     AMOUNT
2array           RULES
3enum                CONSUMPTION_RULE
1poid      PAYINFO_OBJ
1poid      BAL_GRP_OBJ
1enum      PAY_TYPE
1int      PARENT_FLAGS
1int      BILL_WHEN
1int      ACTG_FUTURE_DOM
1enum      ACTG_TYPE
1enum      BILLING_STATUS
1int      BILLING_STATUS_FLAGS
1enum      STATUS
1int      STATUS_FLAGS
1int      SPONSOR_FLAGS
1int      SPONSOREE_FLAGS
1poid      AR_BILLINFO_OBJ
1poid      PARENT_BILLINFO_OBJ
1int      CURRENCY
1int      CURRENCY_SECONDARY
1enum      BILLING_SEGMENT
0arrayBAL_INFO
1poid      POID
1string      NAME
1array      BILLINFO
2poid           POID
2poid           BUSINESS_PROFILE_OBJ
2string           BILLINFO_ID
2array           PAYINFO
3poid                POID
3enum                PAY_TYPE
3enum                PAYMENT_TERM
3int                PAYMENT_OFFSET
3string                NAME
3enum                INV_TYPE
3int                FLAGS
3substruct                INHERITED_INFO
4array                     INV_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DELIVERY_DESCR
5enum                          DELIVERY_PREFER
5string                          INV_INSTR
5enum                          INV_TERMS
5string                          EMAIL_ADDR
5string                          NAME
5string                          STATE
5string                          ZIP
4array                     CC_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_EXP
5string                          DEBIT_NUM
5string                          NAME
5string                          SECURITY_ID
5string                          STATE
5string                          ZIP
4array                     DD_INFO
5string                          ADDRESS
5string                          BANK_NO
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_NUM
5string                          NAME
5string                          STATE
5enum                          TYPE
5string                          ZIP
4array                     SEPA_INFO
5enum                          MANDATE_TYPE
5string                          IBAN
5string                          BIC
5string                          MANDATE_CONTRACT_ID
5string                          MANDATE_CONTRACT_DESCR
5string                          MANDATE_UNIQUE_REFERENCE
5timestamp                          MANDATE_SIGNED_T
5string                          MANDATE_SIGNED_PLACE
5array                          DEBTOR_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               NAME
6string                               ZIP
6string                               IDENTIFICATION_CODE
6string                               REF_PARTY
6string                               REF_PARTY_ID_CODE
5string                          CREDITOR_ID
5string                          CREDITOR_NAME
2array           BAL_INFO
2enum           PAY_TYPE
2int           PARENT_FLAGS
2int           BILL_WHEN
2int           ACTG_FUTURE_DOM
2enum           ACTG_TYPE
2enum           BILLING_STATUS
2int           BILLING_STATUS_FLAGS
2enum           STATUS
2int           STATUS_FLAGS
2int           SPONSOR_FLAGS
2int           SPONSOREE_FLAGS
2poid           AR_BILLINFO_OBJ
2poid           PARENT_BILLINFO_OBJ
2int           CURRENCY
2int           CURRENCY_SECONDARY
2enum           BILLING_SEGMENT
1poid      BILLINFO_OBJ
1array      LIMIT
2decimal           CREDIT_LIMIT
2decimal           CREDIT_FLOOR
2int           CREDIT_THRESHOLDS
2array           THRESHOLDS
3int                THRESHOLD
3decimal                AMOUNT
1array      RULES
2enum           CONSUMPTION_RULE
0arrayPAYINFO
1poid      POID
1enum      PAY_TYPE
1enum      PAYMENT_TERM
1int      PAYMENT_OFFSET
1enum      INV_TYPE
1int      FLAGS
1substruct      INHERITED_INFO
2array           INV_INFO
3string                ADDRESS
3string                CITY
3string                COUNTRY
3string                DELIVERY_DESCR
3enum                DELIVERY_PREFER
3string                INV_INSTR
3enum                INV_TERMS
3string                EMAIL_ADDR
3string                NAME
3string                STATE
3string                ZIP
2array           CC_INFO
3string                ADDRESS
3string                CITY
3string                COUNTRY
3string                DEBIT_EXP
3string                DEBIT_NUM
3string                NAME
3string                SECURITY_ID
3string                STATE
3string                ZIP
2array           DD_INFO
3string                ADDRESS
3string                BANK_NO
3string                CITY
3string                COUNTRY
3string                DEBIT_NUM
3string                NAME
3string                STATE
3enum                TYPE
3string                ZIP
2array           SEPA_INFO
3enum                MANDATE_TYPE
3string                IBAN
3string                BIC
3string                MANDATE_CONTRACT_ID
3string                MANDATE_CONTRACT_DESCR
3string                MANDATE_UNIQUE_REFERENCE
3array                DEBTOR_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     NAME
4string                     ZIP
4string                     IDENTIFICATION_CODE
4string                     REF_PARTY
4string                     REF_PARTY_ID_CODE
3string                CREDITOR_ID
3string                CREDITOR_NAME
0arrayPROFILES
1poid      PROFILE_OBJ
1substruct      INHERITED_INFO
0arrayTOPUP_INFO
1poid      POID
1poid      ACCOUNT_OBJ
1array      PAYINFO
2poid           POID
2enum           PAY_TYPE
2enum           PAYMENT_TERM
2int           PAYMENT_OFFSET
2string           NAME
2enum           INV_TYPE
2int           FLAGS
2substruct           INHERITED_INFO
3array                INV_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DELIVERY_DESCR
4enum                     DELIVERY_PREFER
4string                     INV_INSTR
4enum                     INV_TERMS
4string                     EMAIL_ADDR
4string                     NAME
4string                     STATE
4string                     ZIP
3array                CC_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_EXP
4string                     DEBIT_NUM
4string                     NAME
4string                     SECURITY_ID
4string                     STATE
4string                     ZIP
3array                DD_INFO
4string                     ADDRESS
4string                     BANK_NO
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_NUM
4string                     NAME
4string                     STATE
4enum                     TYPE
4string                     ZIP
3array                SEPA_INFO
4enum                     MANDATE_TYPE
4string                     IBAN
4string                     BIC
4string                     MANDATE_CONTRACT_ID
4string                     MANDATE_CONTRACT_DESCR
4string                     MANDATE_UNIQUE_REFERENCE
4timestamp                     MANDATE_SIGNED_T
4string                     MANDATE_SIGNED_PLACE
4array                     DEBTOR_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          NAME
5string                          ZIP
5string                          IDENTIFICATION_CODE
5string                          REF_PARTY
5string                          REF_PARTY_ID_CODE
4string                     CREDITOR_ID
4string                     CREDITOR_NAME
1poid      PAYINFO_OBJ
1array      BILLINFO
2poid           POID
2poid           BUSINESS_PROFILE_OBJ
2string           BILLINFO_ID
2array           PAYINFO
3poid                POID
3enum                PAY_TYPE
3enum                PAYMENT_TERM
3int                PAYMENT_OFFSET
3string                NAME
3enum                INV_TYPE
3int                FLAGS
3substruct                INHERITED_INFO
4array                     INV_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DELIVERY_DESCR
5enum                          DELIVERY_PREFER
5string                          INV_INSTR
5enum                          INV_TERMS
5string                          EMAIL_ADDR
5string                          NAME
5string                          STATE
5string                          ZIP
4array                     CC_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_EXP
5string                          DEBIT_NUM
5string                          NAME
5string                          SECURITY_ID
5string                          STATE
5string                          ZIP
4array                     DD_INFO
5string                          ADDRESS
5string                          BANK_NO
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_NUM
5string                          NAME
5string                          STATE
5enum                          TYPE
5string                          ZIP
4array                     SEPA_INFO
5enum                          MANDATE_TYPE
5string                          IBAN
5string                          BIC
5string                          MANDATE_CONTRACT_ID
5string                          MANDATE_CONTRACT_DESCR
5string                          MANDATE_UNIQUE_REFERENCE
5timestamp                          MANDATE_SIGNED_T
5string                          MANDATE_SIGNED_PLACE
5array                          DEBTOR_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               NAME
6string                               ZIP
6string                               IDENTIFICATION_CODE
6string                               REF_PARTY
6string                               REF_PARTY_ID_CODE
5string                          CREDITOR_ID
5string                          CREDITOR_NAME
2array           BAL_INFO
3poid                POID
3string                NAME
3array                BILLINFO
3poid                BILLINFO_OBJ
3array                LIMIT
4decimal                     CREDIT_LIMIT
4decimal                     CREDIT_FLOOR
4decimal                     CREDIT_THRESHOLDS_FIXED
4int                     CREDIT_THRESHOLDS
4array                     THRESHOLDS
5int                          THRESHOLD
5decimal                          AMOUNT
3array                RULES
4enum                     CONSUMPTION_RULE
2enum           PAY_TYPE
2int           PARENT_FLAGS
2int           BILL_WHEN
2int           ACTG_FUTURE_DOM
2enum           ACTG_TYPE
2enum           BILLING_STATUS
2int           BILLING_STATUS_FLAGS
2enum           STATUS
2int           STATUS_FLAGS
2int           SPONSOR_FLAGS
2int           SPONSOREE_FLAGS
2poid           AR_BILLINFO_OBJ
2poid           PARENT_BILLINFO_OBJ
2int           CURRENCY
2int           CURRENCY_SECONDARY
2enum           BILLING_SEGMENT
1poid      BILLINFO_OBJ
1decimal      TOPUP_AMT
1decimal      TOPUP_CAP
1decimal      CYCLE_TOPPED_AMT
1timestamp      LAST_TOPUP_T
1array      GROUP_TOPUP_INFO
2poid           POID
2poid           PARENT
2string           NAME
2poid           BAL_GRP_OBJ
2array           GROUP_TOPUP_LIMITS
3int                RESOURCE_ID
3decimal                TOPUP_AMT
3decimal                TOPUP_CAP
2array           GROUP_TOPUP_MEMBERS
3poid                BAL_GRP_OBJ
3int                TOPUP_INTERVAL
3string                PIN
3enum                STATUS
0substructCONTEXT_INFO
1string      CORRELATION_ID
1string      EXTERNAL_USER


Output field index

0poidPOID
0poidACCOUNT_OBJ
0timestampEND_T
0timestampSTART_T
0stringPROGRAM_NAME
0arrayACCTINFO
1poid      POID
1poid      DEAL_OBJ
1substruct      DEAL_INFO
2string           NAME
2string           DESCR
2timestamp           START_T
2timestamp           END_T
2int           FLAGS
2array           PRODUCTS
3poid                PRODUCT_OBJ
3poid                PLAN_OBJ
3poid                OFFERING_OBJ
3int                PACKAGE_ID
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3decimal                PURCHASE_DISCOUNT
3decimal                PURCHASE_DISC_AMT
3decimal                PURCHASE_FEE_AMT
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3decimal                CYCLE_DISCOUNT
3decimal                CYCLE_DISC_AMT
3decimal                CYCLE_FEE_AMT
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3decimal                USAGE_DISCOUNT
3string                DESCR
3string                PRICE_LIST_NAME
2array           DISCOUNTS
3poid                DISCOUNT_OBJ
3poid                PLAN_OBJ
3poid                OFFERING_OBJ
3int                PACKAGE_ID
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3string                DESCR
2array           PERMITTEDS
3string                OBJ_TYPE
1array      BAL_INFO
2poid           POID
2string           NAME
2array           BILLINFO
3poid                POID
3poid                BUSINESS_PROFILE_OBJ
3string                BILLINFO_ID
3array                PAYINFO
4poid                     POID
4enum                     PAY_TYPE
4enum                     PAYMENT_TERM
4int                     PAYMENT_OFFSET
4string                     NAME
4enum                     INV_TYPE
4int                     FLAGS
4substruct                     INHERITED_INFO
5array                          INV_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DELIVERY_DESCR
6enum                               DELIVERY_PREFER
6string                               INV_INSTR
6enum                               INV_TERMS
6string                               EMAIL_ADDR
6string                               NAME
6string                               STATE
6string                               ZIP
5array                          CC_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_EXP
6string                               DEBIT_NUM
6string                               NAME
6string                               SECURITY_ID
6string                               STATE
6string                               ZIP
5array                          DD_INFO
6string                               ADDRESS
6string                               BANK_NO
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_NUM
6string                               NAME
6string                               STATE
6enum                               TYPE
6string                               ZIP
5array                          SEPA_INFO
6enum                               MANDATE_TYPE
6string                               IBAN
6string                               BIC
6string                               MANDATE_CONTRACT_ID
6string                               MANDATE_CONTRACT_DESCR
6string                               MANDATE_UNIQUE_REFERENCE
6timestamp                               MANDATE_SIGNED_T
6string                               MANDATE_SIGNED_PLACE
6array                               DEBTOR_INFO
7string                                    ADDRESS
7string                                    CITY
7string                                    COUNTRY
7string                                    NAME
7string                                    ZIP
7string                                    IDENTIFICATION_CODE
7string                                    REF_PARTY
7string                                    REF_PARTY_ID_CODE
6string                               CREDITOR_ID
6string                               CREDITOR_NAME
3array                BAL_INFO
3enum                PAY_TYPE
3int                PARENT_FLAGS
3int                BILL_WHEN
3int                ACTG_FUTURE_DOM
3enum                ACTG_TYPE
3enum                BILLING_STATUS
3int                BILLING_STATUS_FLAGS
3enum                STATUS
3int                STATUS_FLAGS
3int                SPONSOR_FLAGS
3int                SPONSOREE_FLAGS
3poid                AR_BILLINFO_OBJ
3poid                PARENT_BILLINFO_OBJ
3int                CURRENCY
3int                CURRENCY_SECONDARY
3enum                BILLING_SEGMENT
2poid           BILLINFO_OBJ
2array           LIMIT
3decimal                CREDIT_LIMIT
3decimal                CREDIT_FLOOR
3decimal                CREDIT_THRESHOLDS_FIXED
3int                CREDIT_THRESHOLDS
3array                THRESHOLDS
4int                     THRESHOLD
4decimal                     AMOUNT
2array           RULES
3enum                CONSUMPTION_RULE
1poid      BAL_GRP_OBJ
1int      CURRENCY
1int      CURRENCY_SECONDARY
0arraySERVICES
1poid      SERVICE_OBJ
1int      SUBSCRIPTION_INDEX
1poid      SUBSCRIPTION_OBJ
1poid      BILLINFO_OBJ
1string      SERVICE_ID
1array      BAL_INFO
2poid           POID
2string           NAME
2array           BILLINFO
3poid                POID
3poid                BUSINESS_PROFILE_OBJ
3string                BILLINFO_ID
3array                PAYINFO
4poid                     POID
4enum                     PAY_TYPE
4enum                     PAYMENT_TERM
4int                     PAYMENT_OFFSET
4string                     NAME
4enum                     INV_TYPE
4int                     FLAGS
4substruct                     INHERITED_INFO
5array                          INV_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DELIVERY_DESCR
6enum                               DELIVERY_PREFER
6string                               INV_INSTR
6enum                               INV_TERMS
6string                               EMAIL_ADDR
6string                               NAME
6string                               STATE
6string                               ZIP
5array                          CC_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_EXP
6string                               DEBIT_NUM
6string                               NAME
6string                               SECURITY_ID
6string                               STATE
6string                               ZIP
5array                          DD_INFO
6string                               ADDRESS
6string                               BANK_NO
6string                               CITY
6string                               COUNTRY
6string                               DEBIT_NUM
6string                               NAME
6string                               STATE
6enum                               TYPE
6string                               ZIP
5array                          SEPA_INFO
6enum                               MANDATE_TYPE
6string                               IBAN
6string                               BIC
6string                               MANDATE_CONTRACT_ID
6string                               MANDATE_CONTRACT_DESCR
6string                               MANDATE_UNIQUE_REFERENCE
6timestamp                               MANDATE_SIGNED_T
6string                               MANDATE_SIGNED_PLACE
6array                               DEBTOR_INFO
7string                                    ADDRESS
7string                                    CITY
7string                                    COUNTRY
7string                                    NAME
7string                                    ZIP
7string                                    IDENTIFICATION_CODE
7string                                    REF_PARTY
7string                                    REF_PARTY_ID_CODE
6string                               CREDITOR_ID
6string                               CREDITOR_NAME
3array                BAL_INFO
3enum                PAY_TYPE
3int                PARENT_FLAGS
3int                BILL_WHEN
3int                ACTG_FUTURE_DOM
3enum                ACTG_TYPE
3enum                BILLING_STATUS
3int                BILLING_STATUS_FLAGS
3enum                STATUS
3int                STATUS_FLAGS
3int                SPONSOR_FLAGS
3int                SPONSOREE_FLAGS
3poid                AR_BILLINFO_OBJ
3poid                PARENT_BILLINFO_OBJ
3int                CURRENCY
3int                CURRENCY_SECONDARY
3enum                BILLING_SEGMENT
2poid           BILLINFO_OBJ
2array           LIMIT
3decimal                CREDIT_LIMIT
3decimal                CREDIT_FLOOR
3decimal                CREDIT_THRESHOLDS_FIXED
3int                CREDIT_THRESHOLDS
3array                THRESHOLDS
4int                     THRESHOLD
4decimal                     AMOUNT
2array           RULES
3enum                CONSUMPTION_RULE
1poid      BAL_GRP_OBJ
1string      LOGIN
1array      ALIAS_LIST
2string           NAME
1enum      PASSWD_STATUS
1poid      DEAL_OBJ
1substruct      DEAL_INFO
2string           NAME
2string           DESCR
2timestamp           START_T
2timestamp           END_T
2int           FLAGS
2array           PRODUCTS
3poid                PRODUCT_OBJ
3poid                PLAN_OBJ
3poid                OFFERING_OBJ
3int                PACKAGE_ID
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3decimal                PURCHASE_DISCOUNT
3decimal                PURCHASE_DISC_AMT
3decimal                PURCHASE_FEE_AMT
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3decimal                CYCLE_DISCOUNT
3decimal                CYCLE_DISC_AMT
3decimal                CYCLE_FEE_AMT
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3decimal                USAGE_DISCOUNT
3string                DESCR
3string                PRICE_LIST_NAME
2array           DISCOUNTS
3poid                DISCOUNT_OBJ
3poid                PLAN_OBJ
3poid                OFFERING_OBJ
3int                PACKAGE_ID
3decimal                QUANTITY
3enum                STATUS
3int                STATUS_FLAGS
3timestamp                PURCHASE_START_T
3int                PURCHASE_START_UNIT
3int                PURCHASE_START_OFFSET
3timestamp                PURCHASE_END_T
3int                PURCHASE_END_UNIT
3int                PURCHASE_END_OFFSET
3timestamp                CYCLE_START_T
3int                CYCLE_START_UNIT
3int                CYCLE_START_OFFSET
3timestamp                CYCLE_END_T
3int                CYCLE_END_UNIT
3int                CYCLE_END_OFFSET
3timestamp                USAGE_START_T
3int                USAGE_START_UNIT
3int                USAGE_START_OFFSET
3timestamp                USAGE_END_T
3int                USAGE_END_UNIT
3int                USAGE_END_OFFSET
3string                DESCR
2array           PERMITTEDS
3string                OBJ_TYPE
1array      DEALS
2poid           DEAL_OBJ
2enum           TYPE
2substruct           DEAL_INFO
3string                NAME
3string                DESCR
3timestamp                START_T
3timestamp                END_T
3int                FLAGS
3array                PRODUCTS
4poid                     PRODUCT_OBJ
4poid                     PLAN_OBJ
4poid                     OFFERING_OBJ
4int                     PACKAGE_ID
4decimal                     QUANTITY
4enum                     STATUS
4int                     STATUS_FLAGS
4timestamp                     PURCHASE_START_T
4int                     PURCHASE_START_UNIT
4int                     PURCHASE_START_OFFSET
4timestamp                     PURCHASE_END_T
4int                     PURCHASE_END_UNIT
4int                     PURCHASE_END_OFFSET
4decimal                     PURCHASE_DISCOUNT
4decimal                     PURCHASE_DISC_AMT
4decimal                     PURCHASE_FEE_AMT
4timestamp                     CYCLE_START_T
4int                     CYCLE_START_UNIT
4int                     CYCLE_START_OFFSET
4timestamp                     CYCLE_END_T
4int                     CYCLE_END_UNIT
4int                     CYCLE_END_OFFSET
4decimal                     CYCLE_DISCOUNT
4decimal                     CYCLE_DISC_AMT
4decimal                     CYCLE_FEE_AMT
4timestamp                     USAGE_START_T
4int                     USAGE_START_UNIT
4int                     USAGE_START_OFFSET
4timestamp                     USAGE_END_T
4int                     USAGE_END_UNIT
4int                     USAGE_END_OFFSET
4decimal                     USAGE_DISCOUNT
4string                     DESCR
4string                     PRICE_LIST_NAME
3array                DISCOUNTS
4poid                     DISCOUNT_OBJ
4poid                     PLAN_OBJ
4poid                     OFFERING_OBJ
4int                     PACKAGE_ID
4decimal                     QUANTITY
4enum                     STATUS
4int                     STATUS_FLAGS
4timestamp                     PURCHASE_START_T
4int                     PURCHASE_START_UNIT
4int                     PURCHASE_START_OFFSET
4timestamp                     PURCHASE_END_T
4int                     PURCHASE_END_UNIT
4int                     PURCHASE_END_OFFSET
4timestamp                     CYCLE_START_T
4int                     CYCLE_START_UNIT
4int                     CYCLE_START_OFFSET
4timestamp                     CYCLE_END_T
4int                     CYCLE_END_UNIT
4int                     CYCLE_END_OFFSET
4timestamp                     USAGE_START_T
4int                     USAGE_START_UNIT
4int                     USAGE_START_OFFSET
4timestamp                     USAGE_END_T
4int                     USAGE_END_UNIT
4int                     USAGE_END_OFFSET
4string                     DESCR
3array                PERMITTEDS
4string                     OBJ_TYPE
1array      STATUSES
2enum           STATUS
2int           STATUS_FLAGS
2timestamp           CLOSE_WHEN_T
1array      PROFILES
2poid           PROFILE_OBJ
2substruct           INHERITED_INFO
1substruct      INHERITED_INFO
1array      DEVICES
2poid           DEVICE_OBJ
0arrayBILLINFO
1poid      POID
1poid      BUSINESS_PROFILE_OBJ
1string      BILLINFO_ID
1int      ACTG_CYCLE_DOM
1poid      PAYINFO_OBJ
1poid      BAL_GRP_OBJ
1int      FLAGS
1enum      PAY_TYPE
1int      PARENT_FLAGS
1int      BILL_WHEN
1int      ACTG_FUTURE_DOM
1enum      ACTG_TYPE
1enum      BILLING_STATUS
1int      BILLING_STATUS_FLAGS
1enum      STATUS
1int      STATUS_FLAGS
1int      SPONSOR_FLAGS
1int      SPONSOREE_FLAGS
1poid      AR_BILLINFO_OBJ
1poid      PARENT_BILLINFO_OBJ
1int      CURRENCY
1int      CURRENCY_SECONDARY
1enum      BILLING_SEGMENT
1timestamp      EFFECTIVE_T
0arrayBAL_INFO
1poid      POID
1string      NAME
1poid      BILLINFO_OBJ
1poid      ACCOUNT_OBJ
1poid      SERVICE_OBJ
1array      LIMIT
2decimal           CREDIT_LIMIT
2decimal           CREDIT_FLOOR
2int           CREDIT_THRESHOLDS
2array           THRESHOLDS
3int                THRESHOLD
1array      RULES
2enum           CONSUMPTION_RULE
0arrayPAYINFO
1poid      POID
1enum      PAY_TYPE
1enum      PAYMENT_TERM
1int      PAYMENT_OFFSET
1enum      INV_TYPE
1int      FLAGS
1substruct      INHERITED_INFO
2array           INV_INFO
3string                ADDRESS
3string                CITY
3string                COUNTRY
3string                DELIVERY_DESCR
3enum                DELIVERY_PREFER
3string                INV_INSTR
3enum                INV_TERMS
3string                EMAIL_ADDR
3string                NAME
3string                STATE
3string                ZIP
2array           CC_INFO
3string                ADDRESS
3string                CITY
3string                COUNTRY
3string                DEBIT_EXP
3string                DEBIT_NUM
3string                NAME
3string                SECURITY_ID
3string                STATE
3string                ZIP
2array           DD_INFO
3string                ADDRESS
3string                BANK_NO
3string                CITY
3string                COUNTRY
3string                DEBIT_NUM
3string                NAME
3string                STATE
3enum                TYPE
3string                ZIP
2array           SEPA_INFO
3enum                MANDATE_TYPE
3string                IBAN
3string                BIC
3string                MANDATE_CONTRACT_ID
3string                MANDATE_CONTRACT_DESCR
3string                MANDATE_UNIQUE_REFERENCE
3array                DEBTOR_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     NAME
4string                     ZIP
4string                     IDENTIFICATION_CODE
4string                     REF_PARTY
4string                     REF_PARTY_ID_CODE
3string                CREDITOR_ID
3string                CREDITOR_NAME
0arrayPROFILES
1poid      PROFILE_OBJ
1substruct      INHERITED_INFO
0arrayTOPUP_INFO
1poid      POID
1poid      ACCOUNT_OBJ
1array      PAYINFO
2poid           POID
2enum           PAY_TYPE
2enum           PAYMENT_TERM
2int           PAYMENT_OFFSET
2string           NAME
2enum           INV_TYPE
2int           FLAGS
2substruct           INHERITED_INFO
3array                INV_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DELIVERY_DESCR
4enum                     DELIVERY_PREFER
4string                     INV_INSTR
4enum                     INV_TERMS
4string                     EMAIL_ADDR
4string                     NAME
4string                     STATE
4string                     ZIP
3array                CC_INFO
4string                     ADDRESS
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_EXP
4string                     DEBIT_NUM
4string                     NAME
4string                     SECURITY_ID
4string                     STATE
4string                     ZIP
3array                DD_INFO
4string                     ADDRESS
4string                     BANK_NO
4string                     CITY
4string                     COUNTRY
4string                     DEBIT_NUM
4string                     NAME
4string                     STATE
4enum                     TYPE
4string                     ZIP
3array                SEPA_INFO
4enum                     MANDATE_TYPE
4string                     IBAN
4string                     BIC
4string                     MANDATE_CONTRACT_ID
4string                     MANDATE_CONTRACT_DESCR
4string                     MANDATE_UNIQUE_REFERENCE
4timestamp                     MANDATE_SIGNED_T
4string                     MANDATE_SIGNED_PLACE
4array                     DEBTOR_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          NAME
5string                          ZIP
5string                          IDENTIFICATION_CODE
5string                          REF_PARTY
5string                          REF_PARTY_ID_CODE
4string                     CREDITOR_ID
4string                     CREDITOR_NAME
1array      BILLINFO
2poid           POID
2poid           BUSINESS_PROFILE_OBJ
2string           BILLINFO_ID
2array           PAYINFO
3poid                POID
3enum                PAY_TYPE
3enum                PAYMENT_TERM
3int                PAYMENT_OFFSET
3string                NAME
3enum                INV_TYPE
3int                FLAGS
3substruct                INHERITED_INFO
4array                     INV_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DELIVERY_DESCR
5enum                          DELIVERY_PREFER
5string                          INV_INSTR
5enum                          INV_TERMS
5string                          EMAIL_ADDR
5string                          NAME
5string                          STATE
5string                          ZIP
4array                     CC_INFO
5string                          ADDRESS
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_EXP
5string                          DEBIT_NUM
5string                          NAME
5string                          SECURITY_ID
5string                          STATE
5string                          ZIP
4array                     DD_INFO
5string                          ADDRESS
5string                          BANK_NO
5string                          CITY
5string                          COUNTRY
5string                          DEBIT_NUM
5string                          NAME
5string                          STATE
5enum                          TYPE
5string                          ZIP
4array                     SEPA_INFO
5enum                          MANDATE_TYPE
5string                          IBAN
5string                          BIC
5string                          MANDATE_CONTRACT_ID
5string                          MANDATE_CONTRACT_DESCR
5string                          MANDATE_UNIQUE_REFERENCE
5timestamp                          MANDATE_SIGNED_T
5string                          MANDATE_SIGNED_PLACE
5array                          DEBTOR_INFO
6string                               ADDRESS
6string                               CITY
6string                               COUNTRY
6string                               NAME
6string                               ZIP
6string                               IDENTIFICATION_CODE
6string                               REF_PARTY
6string                               REF_PARTY_ID_CODE
5string                          CREDITOR_ID
5string                          CREDITOR_NAME
2array           BAL_INFO
3poid                POID
3string                NAME
3array                BILLINFO
3poid                BILLINFO_OBJ
3array                LIMIT
4decimal                     CREDIT_LIMIT
4decimal                     CREDIT_FLOOR
4decimal                     CREDIT_THRESHOLDS_FIXED
4int                     CREDIT_THRESHOLDS
4array                     THRESHOLDS
5int                          THRESHOLD
5decimal                          AMOUNT
3array                RULES
4enum                     CONSUMPTION_RULE
2enum           PAY_TYPE
2int           PARENT_FLAGS
2int           BILL_WHEN
2int           ACTG_FUTURE_DOM
2enum           ACTG_TYPE
2enum           BILLING_STATUS
2int           BILLING_STATUS_FLAGS
2enum           STATUS
2int           STATUS_FLAGS
2int           SPONSOR_FLAGS
2int           SPONSOREE_FLAGS
2poid           AR_BILLINFO_OBJ
2poid           PARENT_BILLINFO_OBJ
2int           CURRENCY
2int           CURRENCY_SECONDARY
2enum           BILLING_SEGMENT
1poid      PAYINFO_OBJ
1poid      BILLINFO_OBJ
1decimal      TOPUP_AMT
1decimal      TOPUP_CAP
1decimal      CYCLE_TOPPED_AMT
1timestamp      LAST_TOPUP_T
1array      GROUP_TOPUP_INFO
2poid           POID
2poid           PARENT
2string           NAME
2poid           BAL_GRP_OBJ
2array           GROUP_TOPUP_LIMITS
3int                RESOURCE_ID
3decimal                TOPUP_AMT
3decimal                TOPUP_CAP
2array           GROUP_TOPUP_MEMBERS
3poid                BAL_GRP_OBJ
3int                TOPUP_INTERVAL
3string                PIN
3enum                STATUS
0substructCONTEXT_INFO
1string      CORRELATION_ID
1string      EXTERNAL_USER


Input details

0poid    POID
Userequired
Class/plan
Class/account

The poid of the chosen addon plan or account to be modified.

0poid    ACCOUNT_OBJ
Userequired
Class/account

The poid of account object to be modified.

0timestamp    END_T
Useoptional

This field represents the timestamp at which the event ends. This also represents the effective time of update to this account, on an external system. If this field is not specified, then current time on the Oracle Monetization Cloud server will be considered.

0timestamp    START_T
Useoptional

This would be the timestamp to be used to generate events. If not specified, the current time on the Oracle Monetization Cloud server will be considered.

0string    PROGRAM_NAME
Useoptional
Max length60

The name of the program that executed this operation.

0array    ACCTINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements0
Allow ELEMID_ANYfalse

Information to be stored in the account object will be passed in the acctinfo.

1poid    DEAL_OBJ
Useoptional
Parent in.ACCTINFO
Class/deal

Account level deal to purchase (if any).

1substruct    DEAL_INFO
Useoptional
Parent in.ACCTINFO
Recursivefalse

Deal to be purchased at account level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

2string    NAME
Useoptional
Parent in.ACCTINFO.DEAL_INFO
Max length255

Name of the deal object. Present only if a customized deal is to be purchased.

2string    DESCR
Useoptional
Parent in.ACCTINFO.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

2timestamp    START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

2timestamp    END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

2int    FLAGS
Useoptional
Parent in.ACCTINFO.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

2array    PRODUCTS
Useoptional
Parent in.ACCTINFO.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

3poid    PRODUCT_OBJ
Userequired
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

3poid    PLAN_OBJ
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

3decimal    QUANTITY
Userequired
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3timestamp    PURCHASE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

3int    PURCHASE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3decimal    PURCHASE_DISCOUNT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_DISC_AMT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_FEE_AMT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

3timestamp    CYCLE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

3decimal    CYCLE_DISCOUNT
Userequired
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

3decimal    CYCLE_DISC_AMT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

3decimal    CYCLE_FEE_AMT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

3int    STATUS_FLAGS
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

3timestamp    USAGE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

3decimal    USAGE_DISCOUNT
Userequired
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

3string    DESCR
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

3string    PRICE_LIST_NAME
Useoptional
Parent in.ACCTINFO.DEAL_INFO.PRODUCTS
Max length255

Price list name associated with this offering.

2array    DISCOUNTS
Useoptional
Parent in.ACCTINFO.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

3poid    DISCOUNT_OBJ
Userequired
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

3poid    PLAN_OBJ
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

3decimal    QUANTITY
Userequired
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For later use.

3timestamp    PURCHASE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

3int    PURCHASE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3timestamp    CYCLE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

3timestamp    USAGE_START_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

3string    DESCR
Useoptional
Parent in.ACCTINFO.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

2array    PERMITTEDS
Useoptional
Parent in.ACCTINFO.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

3string    OBJ_TYPE
Userequired
Parent in.ACCTINFO.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    BAL_INFO
Useoptional
Parent in.ACCTINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

Account level balance group indicator. Here the array does not contain anything but the element-id is significant. It indicates which balance group element in the input is account level. It is recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a default balance group will be created.

2poid    POID
Userequired
Parent in.ACCTINFO.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

2string    NAME
Useoptional
Parent in.ACCTINFO.BAL_INFO
Max length255

Balance Group name.

2array    BILLINFO
Useoptional
Parent in.ACCTINFO.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    POID
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

3poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

3string    BILLINFO_ID
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

3array    PAYINFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

4poid    POID
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

4enum    PAY_TYPE
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

4enum    PAYMENT_TERM
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

4int    PAYMENT_OFFSET
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

4string    NAME
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO


4enum    INV_TYPE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

4int    FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

4substruct    INHERITED_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

5array    INV_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

6string    CITY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

6string    DELIVERY_DESCR
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

6enum    DELIVERY_PREFER
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

6string    INV_INSTR
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

6enum    INV_TERMS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

6string    EMAIL_ADDR
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

6string    NAME
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

6string    STATE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

5array    CC_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

6string    CITY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

6string    DEBIT_EXP
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

6string    DEBIT_NUM
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

6string    NAME
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

6string    SECURITY_ID
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

6string    STATE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

5array    DD_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

6string    BANK_NO
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

6string    CITY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

6string    DEBIT_NUM
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

6string    NAME
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

6string    STATE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

6enum    TYPE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

6string    ZIP
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

5array    SEPA_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

6enum    MANDATE_TYPE
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

6string    IBAN
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

6string    BIC
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

6string    MANDATE_CONTRACT_ID
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

6string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

6string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

6timestamp    MANDATE_SIGNED_T
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

6string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

6array    DEBTOR_INFO
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

7string    ADDRESS
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

7string    CITY
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

7string    COUNTRY
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

7string    NAME
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

7string    ZIP
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

7string    IDENTIFICATION_CODE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

7string    REF_PARTY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

7string    REF_PARTY_ID_CODE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

6string    CREDITOR_ID
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

6string    CREDITOR_NAME
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

3array    BAL_INFO
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3enum    PAY_TYPE
Userequired
Parent in.ACCTINFO.BAL_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

3int    PARENT_FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

3int    BILL_WHEN
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

Anniversary billing slot.

3int    ACTG_FUTURE_DOM
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

3enum    ACTG_TYPE
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

3enum    BILLING_STATUS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

3int    BILLING_STATUS_FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

3enum    STATUS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

3int    STATUS_FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

3int    SPONSOR_FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

3int    SPONSOREE_FLAGS
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

3poid    AR_BILLINFO_OBJ
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

3poid    PARENT_BILLINFO_OBJ
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

3int    CURRENCY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3int    CURRENCY_SECONDARY
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3enum    BILLING_SEGMENT
Useoptional
Parent in.ACCTINFO.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

2poid    BILLINFO_OBJ
Useoptional
Parent in.ACCTINFO.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

2array    LIMIT
Useoptional
Parent in.ACCTINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

3decimal    CREDIT_LIMIT
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3decimal    CREDIT_FLOOR
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

3decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3int    CREDIT_THRESHOLDS
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

3array    THRESHOLDS
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

4int    THRESHOLD
Userequired
Parent in.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

4decimal    AMOUNT
Useoptional
Parent in.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

2array    RULES
Useoptional
Parent in.ACCTINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

3enum    CONSUMPTION_RULE
Useoptional
Parent in.ACCTINFO.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

1poid    BAL_GRP_OBJ
Useoptional
Parent in.ACCTINFO
Class/balance_group

The balance group object for the account. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

1int    CURRENCY
Userequired
Parent in.ACCTINFO

The primary currency of the account. Also this acts as element-id of primary balance element for accounting roll-up. If not provided the default account currency information will be read from CM's pin.conf.

1int    CURRENCY_SECONDARY
Userequired
Parent in.ACCTINFO

The secondary currency of the account. Also this acts as element-id of secondary balance element for accounting roll-up.

0array    SERVICES
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

This represents services array.

1poid    SERVICE_OBJ
Userequired
Parent in.SERVICES
Modetypeonly
Class/service

Partial poid of service object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored.

1int    SUBSCRIPTION_INDEX
Useoptional
Parent in.SERVICES

If this is a member service of a line/subscription, the index points to the parent/subscription service of the line. The member service object, when created, will refer the parent/subscription service using the SUBSCRIPTION_OBJ field. For all other services, the default is 0.

1poid    SUBSCRIPTION_OBJ
Useoptional
Parent in.SERVICES
Class/service

Subscription service object type only POID. This is an optional field, and it refers to the subscription service object of which this service is a member of.

1string    SERVICE_ID
Useoptional
Parent in.SERVICES
Max length255

User defined name for the service. This identifies the service uniquely within the plan.

1array    BAL_INFO
Useoptional
Parent in.SERVICES
ElemID modekey
Min number of Elements0
Max number of Elements1

Balance Group array which this service instance is associated to. The element-id is significant not the contents of the array. The element-id will be used to identify which balance group array to use from the input to associate the service to. if not specified the service will be associated with the account level balance group.

2poid    POID
Userequired
Parent in.SERVICES.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

2string    NAME
Useoptional
Parent in.SERVICES.BAL_INFO
Max length255

Balance Group name.

2array    BILLINFO
Useoptional
Parent in.SERVICES.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    POID
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

3poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

3string    BILLINFO_ID
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

3array    PAYINFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

4poid    POID
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

4enum    PAY_TYPE
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

4enum    PAYMENT_TERM
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

4int    PAYMENT_OFFSET
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

4string    NAME
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO


4enum    INV_TYPE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

4int    FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

4substruct    INHERITED_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

5array    INV_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

6string    CITY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

6string    DELIVERY_DESCR
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

6enum    DELIVERY_PREFER
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

6string    INV_INSTR
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

6enum    INV_TERMS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

6string    EMAIL_ADDR
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

6string    NAME
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

6string    STATE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

5array    CC_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

6string    CITY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

6string    DEBIT_EXP
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

6string    DEBIT_NUM
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

6string    NAME
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

6string    SECURITY_ID
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

6string    STATE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

5array    DD_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

6string    BANK_NO
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

6string    CITY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

6string    DEBIT_NUM
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

6string    NAME
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

6string    STATE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

6enum    TYPE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

6string    ZIP
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

5array    SEPA_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

6enum    MANDATE_TYPE
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

6string    IBAN
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

6string    BIC
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

6string    MANDATE_CONTRACT_ID
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

6string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

6string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

6timestamp    MANDATE_SIGNED_T
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

6string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

6array    DEBTOR_INFO
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

7string    ADDRESS
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

7string    CITY
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

7string    COUNTRY
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

7string    NAME
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

7string    ZIP
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

7string    IDENTIFICATION_CODE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

7string    REF_PARTY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

7string    REF_PARTY_ID_CODE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

6string    CREDITOR_ID
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

6string    CREDITOR_NAME
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

3array    BAL_INFO
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3enum    PAY_TYPE
Userequired
Parent in.SERVICES.BAL_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

3int    PARENT_FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

3int    BILL_WHEN
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

Anniversary billing slot.

3int    ACTG_FUTURE_DOM
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

3enum    ACTG_TYPE
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

3enum    BILLING_STATUS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

3int    BILLING_STATUS_FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

3enum    STATUS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

3int    STATUS_FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

3int    SPONSOR_FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

3int    SPONSOREE_FLAGS
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

3poid    AR_BILLINFO_OBJ
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

3poid    PARENT_BILLINFO_OBJ
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

3int    CURRENCY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3int    CURRENCY_SECONDARY
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3enum    BILLING_SEGMENT
Useoptional
Parent in.SERVICES.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

2poid    BILLINFO_OBJ
Useoptional
Parent in.SERVICES.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

2array    LIMIT
Useoptional
Parent in.SERVICES.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

3decimal    CREDIT_LIMIT
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3decimal    CREDIT_FLOOR
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

3decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3int    CREDIT_THRESHOLDS
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

3array    THRESHOLDS
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

4int    THRESHOLD
Userequired
Parent in.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

4decimal    AMOUNT
Useoptional
Parent in.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

2array    RULES
Useoptional
Parent in.SERVICES.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

3enum    CONSUMPTION_RULE
Useoptional
Parent in.SERVICES.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

1poid    BAL_GRP_OBJ
Useoptional
Parent in.SERVICES
Class/balance_group

The balance group object for the service. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

1string    LOGIN
Useoptional
Parent in.SERVICES
Max length255

Login for service object. It is optional for telco and GSM services, mandatory for email and ip services.

1array    ALIAS_LIST
Useoptional
Parent in.SERVICES
ElemID modeindex
Min number of Elements0

The array of new aliases. The element-id is significant.

2string    NAME
Useoptional
Parent in.SERVICES.ALIAS_LIST
Max length128

The alias.

1string    PASSWD_CLEAR
Useoptional
Parent in.SERVICES
Max length255

Password for service object.

1enum    PASSWD_STATUS
Useoptional
Parent in.SERVICES

0The password status is valid and normal (PIN_SERV_PASSWDSTATUS_NORMAL).
1The password status is valid and is temporary (PIN_SERV_PASSWDSTATUS_TEMPORARY).
2The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES).
3The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID).
Desired password status. The possible values are NORMAL(0), TEMP(1), EXPIRES(2) and INVALID(3).

1poid    DEAL_OBJ
Useoptional
Parent in.SERVICES
Class/deal

Deal that service object purchased (if any). This is for backward compatibility for the Plan not having PIN_FLD_DEALS array.

1substruct    DEAL_INFO
Useoptional
Parent in.SERVICES
Recursivefalse

Deal to be purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

2string    NAME
Useoptional
Parent in.SERVICES.DEAL_INFO
Max length255

Name of the deal object. Present only if a customized deal is to be purchased.

2string    DESCR
Useoptional
Parent in.SERVICES.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

2timestamp    START_T
Useoptional
Parent in.SERVICES.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

2timestamp    END_T
Useoptional
Parent in.SERVICES.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

2int    FLAGS
Useoptional
Parent in.SERVICES.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

2array    PRODUCTS
Useoptional
Parent in.SERVICES.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

3poid    PRODUCT_OBJ
Userequired
Parent in.SERVICES.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

3poid    PLAN_OBJ
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

3decimal    QUANTITY
Userequired
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent in.SERVICES.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3timestamp    PURCHASE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

3int    PURCHASE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3decimal    PURCHASE_DISCOUNT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_DISC_AMT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_FEE_AMT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

3timestamp    CYCLE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

3decimal    CYCLE_DISCOUNT
Userequired
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

3decimal    CYCLE_DISC_AMT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

3decimal    CYCLE_FEE_AMT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

3int    STATUS_FLAGS
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

3timestamp    USAGE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

3decimal    USAGE_DISCOUNT
Userequired
Parent in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

3string    DESCR
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

3string    PRICE_LIST_NAME
Useoptional
Parent in.SERVICES.DEAL_INFO.PRODUCTS
Max length255

Price list name associated with this offering.

2array    DISCOUNTS
Useoptional
Parent in.SERVICES.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

3poid    DISCOUNT_OBJ
Userequired
Parent in.SERVICES.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

3poid    PLAN_OBJ
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

3decimal    QUANTITY
Userequired
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For later use.

3timestamp    PURCHASE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

3int    PURCHASE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3timestamp    CYCLE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

3timestamp    USAGE_START_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

3string    DESCR
Useoptional
Parent in.SERVICES.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

2array    PERMITTEDS
Useoptional
Parent in.SERVICES.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

3string    OBJ_TYPE
Userequired
Parent in.SERVICES.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    DEALS
Useoptional
Parent in.SERVICES
ElemID modeignored
Iterationundefined
Min number of Elements0

This is the array of deals that this service purchases.

2poid    DEAL_OBJ
Useoptional
Parent in.SERVICES.DEALS
Class/deal

This indicates the deal poid that will be purchased without customization.

2enum    TYPE
Useoptional
Parent in.SERVICES.DEALS

0PIN_PRICE_DEAL_OPTIONAL
1PIN_PRICE_DEAL_REQUIRED
Deal option type. Required only if a valid service id is provided.

2substruct    DEAL_INFO
Useoptional
Parent in.SERVICES.DEALS
Recursivefalse

Deal to be purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

3string    NAME
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO
Max length255

Name of the deal object. Present only if a customized deal is to be purchased.

3string    DESCR
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

3timestamp    START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

3timestamp    END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

3int    FLAGS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

3array    PRODUCTS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

4poid    PRODUCT_OBJ
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

4poid    PLAN_OBJ
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

4decimal    QUANTITY
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Quantity to purchase.

4enum    STATUS
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

4timestamp    PURCHASE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

4int    PURCHASE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

4timestamp    PURCHASE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

4int    PURCHASE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

4decimal    PURCHASE_DISCOUNT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

4decimal    PURCHASE_DISC_AMT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

4decimal    PURCHASE_FEE_AMT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

4timestamp    CYCLE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

4int    CYCLE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

4timestamp    CYCLE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

4int    CYCLE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

4decimal    CYCLE_DISCOUNT
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

4decimal    CYCLE_DISC_AMT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

4decimal    CYCLE_FEE_AMT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

4int    STATUS_FLAGS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

4timestamp    USAGE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

4int    USAGE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

4timestamp    USAGE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

4int    USAGE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

4decimal    USAGE_DISCOUNT
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

4string    DESCR
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

3array    DISCOUNTS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

4poid    DISCOUNT_OBJ
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

4poid    PLAN_OBJ
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

4decimal    QUANTITY
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Quantity to purchase.

4enum    STATUS
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

4int    STATUS_FLAGS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For later use.

4timestamp    PURCHASE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

4int    PURCHASE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

4timestamp    PURCHASE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

4int    PURCHASE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

4timestamp    CYCLE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

4int    CYCLE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

4timestamp    CYCLE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

4int    CYCLE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

4timestamp    USAGE_START_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

4int    USAGE_START_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_START_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

4timestamp    USAGE_END_T
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

4int    USAGE_END_UNIT
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_END_OFFSET
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

4string    DESCR
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

3array    PERMITTEDS
Useoptional
Parent in.SERVICES.DEALS.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

4string    OBJ_TYPE
Userequired
Parent in.SERVICES.DEALS.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    STATUSES
Useoptional
Parent in.SERVICES
Min number of Elements0
Max number of Elements1

Desired Status Info - if not specified, an active service is created. The element-id is not significant.

2enum    STATUS
Userequired
Parent in.SERVICES.STATUSES

10100Indicates an active service(PIN_STATUS_ACTIVE).
10102Indicates an inactive service(PIN_STATUS_INACTIVE).
10103Indicates a closed service(PIN_STATUS_CLOSED).
Desired status of the service. The possible values of this field would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).

2int    STATUS_FLAGS
Userequired
Parent in.SERVICES.STATUSES

Desired status flags. This indicates a reason for this service to become inactive or closed.

2timestamp    CLOSE_WHEN_T
Useoptional
Parent in.SERVICES.STATUSES

Desired service close time

1array    PROFILES
Useoptional
Parent in.SERVICES
ElemID modeignored
Iterationundefined
Min number of Elements0

Profiles associate with this service

2poid    PROFILE_OBJ
Userequired
Parent in.SERVICES.PROFILES
Modetypeonly
Class/profile

Partial poid of profile object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored. To modify a profile, specify the complete poid of the profile object.

2substruct    INHERITED_INFO
Useoptional
Parent in.SERVICES.PROFILES

Inherited info for profile object.

1substruct    INHERITED_INFO
Useoptional
Parent in.SERVICES

Inherited info for service object.

1array    DEVICES
Useoptional
Parent in.SERVICES
Min number of Elements0

This is a devices array. This contains an array of device poids to be associated with the service being created.

2poid    DEVICE_OBJ
Userequired
Parent in.SERVICES.DEVICES
Class/device

Poid of the device that is to be associated.

0array    BILLINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements0

This represents the array of Billing info's. The element id is significant as it behaves as a key, in other objects like balance groups (bal_info array) to be created during this operation, to identify which billinfo element to associate with.

1poid    POID
Useoptional
Parent in.BILLINFO
Class/billinfo

The type only billinfo poid to create the billinfo. To update the existing billinfo, specify the complete billinfo poid. If poid is not passed all billinfo's for the account will be picked up for modification.

1poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent in.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

1string    BILLINFO_ID
Useoptional
Parent in.BILLINFO
Max length60

This field identifies the billinfo by name.

1int    ACTG_CYCLE_DOM
Useoptional
Parent in.BILLINFO

Billing date

1array    PAYINFO
Useoptional
Parent in.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

2poid    POID
Userequired
Parent in.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

2enum    PAY_TYPE
Userequired
Parent in.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

2enum    PAYMENT_TERM
Useoptional
Parent in.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

2int    PAYMENT_OFFSET
Useoptional
Parent in.BILLINFO.PAYINFO

Payment offset value.

2string    NAME
Useoptional
Parent in.BILLINFO.PAYINFO


2enum    INV_TYPE
Useoptional
Parent in.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

2int    FLAGS
Useoptional
Parent in.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

2substruct    INHERITED_INFO
Useoptional
Parent in.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

3array    INV_INFO
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

4string    CITY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

4string    DELIVERY_DESCR
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

4enum    DELIVERY_PREFER
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

4string    INV_INSTR
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

4enum    INV_TERMS
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

4string    EMAIL_ADDR
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

4string    NAME
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

4string    STATE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

3array    CC_INFO
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

4string    CITY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

4string    DEBIT_EXP
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

4string    DEBIT_NUM
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

4string    NAME
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

4string    SECURITY_ID
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

4string    STATE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

3array    DD_INFO
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

4string    BANK_NO
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

4string    CITY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

4string    DEBIT_NUM
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

4string    NAME
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

4string    STATE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

4enum    TYPE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

4string    ZIP
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

3array    SEPA_INFO
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

4enum    MANDATE_TYPE
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

4string    IBAN
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

4string    BIC
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

4string    MANDATE_CONTRACT_ID
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

4string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

4string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

4timestamp    MANDATE_SIGNED_T
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

4string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

4array    DEBTOR_INFO
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

5string    ADDRESS
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

5string    CITY
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

5string    COUNTRY
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

5string    NAME
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

5string    ZIP
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

5string    IDENTIFICATION_CODE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

5string    REF_PARTY
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

5string    REF_PARTY_ID_CODE
Useoptional
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

4string    CREDITOR_ID
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

4string    CREDITOR_NAME
Userequired
Parent in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

1array    BAL_INFO
Useoptional
Parent in.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

2poid    POID
Userequired
Parent in.BILLINFO.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

2string    NAME
Useoptional
Parent in.BILLINFO.BAL_INFO
Max length255

Balance Group name.

2array    BILLINFO
Useoptional
Parent in.BILLINFO.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

2poid    BILLINFO_OBJ
Useoptional
Parent in.BILLINFO.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

2array    LIMIT
Useoptional
Parent in.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

3decimal    CREDIT_LIMIT
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3decimal    CREDIT_FLOOR
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

3decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3int    CREDIT_THRESHOLDS
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

3array    THRESHOLDS
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

4int    THRESHOLD
Userequired
Parent in.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

4decimal    AMOUNT
Useoptional
Parent in.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

2array    RULES
Useoptional
Parent in.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

3enum    CONSUMPTION_RULE
Useoptional
Parent in.BILLINFO.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

1poid    PAYINFO_OBJ
Useoptional
Parent in.BILLINFO
Class/payinfo

The payinfo poid that this billinfo is associated with. If PIN_FLD_PAYINFO is specified, this field will be ignored.

1poid    BAL_GRP_OBJ
Useoptional
Parent in.BILLINFO
Class/balance_group

The balance group that this billinfo is associated with. If PIN_FLD_BAL_INFO is specified, this field will be ignored.

1enum    PAY_TYPE
Userequired
Parent in.BILLINFO

0Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
This represents the type of billing for user.

1int    PARENT_FLAGS
Useoptional
Parent in.BILLINFO

Indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

1int    BILL_WHEN
Useoptional
Parent in.BILLINFO

Anniversary billing slot.

1int    ACTG_FUTURE_DOM
Useoptional
Parent in.BILLINFO

New Accounting Close day-of-month (1-31).

1enum    ACTG_TYPE
Useoptional
Parent in.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

1enum    BILLING_STATUS
Useoptional
Parent in.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

1int    BILLING_STATUS_FLAGS
Useoptional
Parent in.BILLINFO

Indicates a reason for setting of the given billing status.

1enum    STATUS
Useoptional
Parent in.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

1int    STATUS_FLAGS
Useoptional
Parent in.BILLINFO

Indicates a reason for setting of the given status.

1int    SPONSOR_FLAGS
Useoptional
Parent in.BILLINFO

It indicates whether this billinfo has a sponsoree.

1int    SPONSOREE_FLAGS
Useoptional
Parent in.BILLINFO

It indicates whether this billinfo has a sponsor.

1poid    AR_BILLINFO_OBJ
Useoptional
Parent in.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

1poid    PARENT_BILLINFO_OBJ
Useoptional
Parent in.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

1int    CURRENCY
Useoptional
Parent in.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

1int    CURRENCY_SECONDARY
Useoptional
Parent in.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

1enum    BILLING_SEGMENT
Useoptional
Parent in.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

0array    BAL_INFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements0

The Balance Group array. List of balance groups that need to be created or updated.

1poid    POID
Userequired
Parent in.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used. To modify an existing balance group, specify the full POID.

1string    NAME
Useoptional
Parent in.BAL_INFO
Max length255

Balance Group name

1array    BILLINFO
Useoptional
Parent in.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

2poid    POID
Userequired
Parent in.BAL_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

2poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent in.BAL_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

2string    BILLINFO_ID
Userequired
Parent in.BAL_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

2array    PAYINFO
Useoptional
Parent in.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

3poid    POID
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

3enum    PAY_TYPE
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

3enum    PAYMENT_TERM
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

3int    PAYMENT_OFFSET
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

3string    NAME
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO


3enum    INV_TYPE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

3int    FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

3substruct    INHERITED_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

4array    INV_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

5string    CITY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

5string    DELIVERY_DESCR
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

5enum    DELIVERY_PREFER
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

5string    INV_INSTR
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

5enum    INV_TERMS
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

5string    EMAIL_ADDR
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

5string    NAME
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

5string    STATE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

4array    CC_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

5string    CITY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

5string    DEBIT_EXP
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

5string    DEBIT_NUM
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

5string    NAME
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

5string    SECURITY_ID
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

5string    STATE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

4array    DD_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

5string    BANK_NO
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

5string    CITY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

5string    DEBIT_NUM
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

5string    NAME
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

5string    STATE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

5enum    TYPE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

5string    ZIP
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

4array    SEPA_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

5enum    MANDATE_TYPE
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

5string    IBAN
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

5string    BIC
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

5string    MANDATE_CONTRACT_ID
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

5string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

5string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

5timestamp    MANDATE_SIGNED_T
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

5string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

5array    DEBTOR_INFO
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

6string    ADDRESS
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

6string    CITY
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

6string    COUNTRY
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

6string    NAME
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

6string    ZIP
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

6string    IDENTIFICATION_CODE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

6string    REF_PARTY
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

6string    REF_PARTY_ID_CODE
Useoptional
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

5string    CREDITOR_ID
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

5string    CREDITOR_NAME
Userequired
Parent in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

2array    BAL_INFO
Useoptional
Parent in.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

2enum    PAY_TYPE
Userequired
Parent in.BAL_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

2int    PARENT_FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

2int    BILL_WHEN
Useoptional
Parent in.BAL_INFO.BILLINFO

Anniversary billing slot.

2int    ACTG_FUTURE_DOM
Useoptional
Parent in.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

2enum    ACTG_TYPE
Useoptional
Parent in.BAL_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

2enum    BILLING_STATUS
Useoptional
Parent in.BAL_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

2int    BILLING_STATUS_FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

2enum    STATUS
Useoptional
Parent in.BAL_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

2int    STATUS_FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

2int    SPONSOR_FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

2int    SPONSOREE_FLAGS
Useoptional
Parent in.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

2poid    AR_BILLINFO_OBJ
Useoptional
Parent in.BAL_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

2poid    PARENT_BILLINFO_OBJ
Useoptional
Parent in.BAL_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

2int    CURRENCY
Useoptional
Parent in.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2int    CURRENCY_SECONDARY
Useoptional
Parent in.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2enum    BILLING_SEGMENT
Useoptional
Parent in.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

1poid    BILLINFO_OBJ
Useoptional
Parent in.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

1array    LIMIT
Useoptional
Parent in.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

2decimal    CREDIT_LIMIT
Useoptional
Parent in.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

2decimal    CREDIT_FLOOR
Useoptional
Parent in.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

2int    CREDIT_THRESHOLDS
Useoptional
Parent in.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

2array    THRESHOLDS
Useoptional
Parent in.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

3int    THRESHOLD
Userequired
Parent in.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

3decimal    AMOUNT
Useoptional
Parent in.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

1array    RULES
Useoptional
Parent in.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

2enum    CONSUMPTION_RULE
Useoptional
Parent in.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

0array    PAYINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements1

This is an array of payment methods to be associated with this account.

1poid    POID
Userequired
Parent in.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo to be created. In case of an update to an existing payinfo, specifiy the actual payinfo poid.

1enum    PAY_TYPE
Userequired
Parent in.PAYINFO

0Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
This represents the type of billing for user.

1enum    PAYMENT_TERM
Useoptional
Parent in.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

1int    PAYMENT_OFFSET
Useoptional
Parent in.PAYINFO

Payment Offset.

1enum    INV_TYPE
Useoptional
Parent in.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT)
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

1int    FLAGS
Useoptional
Parent in.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

1substruct    INHERITED_INFO
Useoptional
Parent in.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

2array    INV_INFO
Useoptional
Parent in.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

3string    CITY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

3string    DELIVERY_DESCR
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

3enum    DELIVERY_PREFER
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

3string    INV_INSTR
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

3enum    INV_TERMS
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

3string    EMAIL_ADDR
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

3string    NAME
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

3string    STATE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

3string    ZIP
Useoptional
Parent in.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

2array    CC_INFO
Useoptional
Parent in.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address.

3string    CITY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

3string    DEBIT_EXP
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

3string    DEBIT_NUM
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

3string    NAME
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

3string    SECURITY_ID
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

3string    STATE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

3string    ZIP
Useoptional
Parent in.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

2array    DD_INFO
Useoptional
Parent in.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

3string    BANK_NO
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

3string    CITY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

3string    DEBIT_NUM
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

3string    NAME
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

3string    STATE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

3enum    TYPE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type- Checking(1), savings(2) or corporate(3).

3string    ZIP
Useoptional
Parent in.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

2array    SEPA_INFO
Useoptional
Parent in.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment menthod. There will be only one element and element id is not significant.

3enum    MANDATE_TYPE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

3string    IBAN
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

3string    BIC
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

3string    MANDATE_CONTRACT_ID
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

3string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

3string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

3array    DEBTOR_INFO
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

4string    ADDRESS
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

4string    CITY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

4string    COUNTRY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

4string    NAME
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

4string    ZIP
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

4string    IDENTIFICATION_CODE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

4string    REF_PARTY
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

4string    REF_PARTY_ID_CODE
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

3string    CREDITOR_ID
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

3string    CREDITOR_NAME
Useoptional
Parent in.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

0array    PROFILES
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

This represnts Profile array to be associated with the account.

1poid    PROFILE_OBJ
Userequired
Parent in.PROFILES
Modetypeonly
Class/profile

Partial poid of profile object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored. In case of modification to an existing profile specify the actual poid of the profile.

1substruct    INHERITED_INFO
Useoptional
Parent in.PROFILES
Recursivefalse

Inherited info for profile object.

0array    TOPUP_INFO
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

Topup array

1poid    POID
Userequired
Parent in.TOPUP_INFO
Class/topup

Topup poid - type only for creation.

1poid    ACCOUNT_OBJ
Useoptional
Parent in.TOPUP_INFO
Class/account

Account poid.

1array    PAYINFO
Userequired
Parent in.TOPUP_INFO
ElemID modekey
Iterationundefined
Min number of Elements1

The element-id is significant. Contents are not significant. The element id points to the payinfo array element in the request to be used for top-up.

2poid    POID
Userequired
Parent in.TOPUP_INFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

2enum    PAY_TYPE
Userequired
Parent in.TOPUP_INFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

2enum    PAYMENT_TERM
Useoptional
Parent in.TOPUP_INFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

2int    PAYMENT_OFFSET
Useoptional
Parent in.TOPUP_INFO.PAYINFO

Payment offset value.

2string    NAME
Useoptional
Parent in.TOPUP_INFO.PAYINFO


2enum    INV_TYPE
Useoptional
Parent in.TOPUP_INFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

2int    FLAGS
Useoptional
Parent in.TOPUP_INFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

2substruct    INHERITED_INFO
Useoptional
Parent in.TOPUP_INFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

3array    INV_INFO
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

4string    CITY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

4string    DELIVERY_DESCR
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

4enum    DELIVERY_PREFER
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

4string    INV_INSTR
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

4enum    INV_TERMS
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

4string    EMAIL_ADDR
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

4string    NAME
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

4string    STATE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

3array    CC_INFO
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

4string    CITY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

4string    DEBIT_EXP
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

4string    DEBIT_NUM
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

4string    NAME
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

4string    SECURITY_ID
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

4string    STATE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

3array    DD_INFO
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

4string    BANK_NO
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

4string    CITY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

4string    DEBIT_NUM
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

4string    NAME
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

4string    STATE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

4enum    TYPE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

4string    ZIP
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

3array    SEPA_INFO
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

4enum    MANDATE_TYPE
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

4string    IBAN
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

4string    BIC
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

4string    MANDATE_CONTRACT_ID
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

4string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

4string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

4timestamp    MANDATE_SIGNED_T
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

4string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

4array    DEBTOR_INFO
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

5string    ADDRESS
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

5string    CITY
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

5string    COUNTRY
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

5string    NAME
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

5string    ZIP
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

5string    IDENTIFICATION_CODE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

5string    REF_PARTY
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

5string    REF_PARTY_ID_CODE
Useoptional
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

4string    CREDITOR_ID
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

4string    CREDITOR_NAME
Userequired
Parent in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

1poid    PAYINFO_OBJ
Useoptional
Parent in.TOPUP_INFO
Class/payinfo

The payinfo object that this topup is associated with. If PIN_FLD_PAYINFO is passed in, this field will be ignored. If PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.

1array    BILLINFO
Userequired
Parent in.TOPUP_INFO
ElemID modekey
Iterationundefined
Min number of Elements1

The element-id is significant. Contents are not significant. The element id points to the billinfo array element in the request to be used for top-up.

2poid    POID
Userequired
Parent in.TOPUP_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

2poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent in.TOPUP_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

2string    BILLINFO_ID
Userequired
Parent in.TOPUP_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

2array    PAYINFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

3poid    POID
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

3enum    PAY_TYPE
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

3enum    PAYMENT_TERM
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

3int    PAYMENT_OFFSET
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO

Payment offset value.

3string    NAME
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO


3enum    INV_TYPE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

3int    FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

3substruct    INHERITED_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

4array    INV_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

5string    CITY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

5string    DELIVERY_DESCR
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

5enum    DELIVERY_PREFER
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

5string    INV_INSTR
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

5enum    INV_TERMS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

5string    EMAIL_ADDR
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

5string    NAME
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

5string    STATE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

4array    CC_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

5string    CITY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

5string    DEBIT_EXP
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

5string    DEBIT_NUM
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

5string    NAME
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

5string    SECURITY_ID
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

5string    STATE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

4array    DD_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

5string    BANK_NO
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

5string    CITY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

5string    DEBIT_NUM
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

5string    NAME
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

5string    STATE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

5enum    TYPE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

5string    ZIP
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

4array    SEPA_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

5enum    MANDATE_TYPE
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

5string    IBAN
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

5string    BIC
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

5string    MANDATE_CONTRACT_ID
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

5string    MANDATE_CONTRACT_DESCR
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

5string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

5timestamp    MANDATE_SIGNED_T
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

5string    MANDATE_SIGNED_PLACE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

5array    DEBTOR_INFO
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

6string    ADDRESS
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

6string    CITY
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

6string    COUNTRY
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

6string    NAME
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

6string    ZIP
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

6string    IDENTIFICATION_CODE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

6string    REF_PARTY
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

6string    REF_PARTY_ID_CODE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

5string    CREDITOR_ID
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

5string    CREDITOR_NAME
Userequired
Parent in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

2array    BAL_INFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3poid    POID
Userequired
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

3string    NAME
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
Max length255

Balance Group name.

3array    BILLINFO
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    BILLINFO_OBJ
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

3array    LIMIT
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

4decimal    CREDIT_LIMIT
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

4decimal    CREDIT_FLOOR
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

4decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

4int    CREDIT_THRESHOLDS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

4array    THRESHOLDS
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

5int    THRESHOLD
Userequired
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

5decimal    AMOUNT
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

3array    RULES
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

4enum    CONSUMPTION_RULE
Useoptional
Parent in.TOPUP_INFO.BILLINFO.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

2enum    PAY_TYPE
Userequired
Parent in.TOPUP_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

2int    PARENT_FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

2int    BILL_WHEN
Useoptional
Parent in.TOPUP_INFO.BILLINFO

Anniversary billing slot.

2int    ACTG_FUTURE_DOM
Useoptional
Parent in.TOPUP_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

2enum    ACTG_TYPE
Useoptional
Parent in.TOPUP_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

2enum    BILLING_STATUS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

2int    BILLING_STATUS_FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

2enum    STATUS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

2int    STATUS_FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given status.

2int    SPONSOR_FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

2int    SPONSOREE_FLAGS
Useoptional
Parent in.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

2poid    AR_BILLINFO_OBJ
Useoptional
Parent in.TOPUP_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

2poid    PARENT_BILLINFO_OBJ
Useoptional
Parent in.TOPUP_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

2int    CURRENCY
Useoptional
Parent in.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2int    CURRENCY_SECONDARY
Useoptional
Parent in.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2enum    BILLING_SEGMENT
Useoptional
Parent in.TOPUP_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

1poid    BILLINFO_OBJ
Useoptional
Parent in.TOPUP_INFO
Class/billinfo

The POID of Billinfo that this topup is associated with. If PIN_FLD_BILLINFO is passed in, this field will be ignored. If PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.

1decimal    TOPUP_AMT
Userequired
Parent in.TOPUP_INFO

This represents Topup amount. In case of auto-topups this will indicate the amount to topup with.

1decimal    TOPUP_CAP
Useoptional
Parent in.TOPUP_INFO

Topup cap indicates the max topup that can be done for a given cycle. The cycle is driven by the cycle information set-up in the billinfo. A values of 0 means no cap.

1decimal    CYCLE_TOPPED_AMT
Useoptional
Parent in.TOPUP_INFO

This indicates the total topped up amount during the given cycle. This amount will be populated only if the cap is set.

1timestamp    LAST_TOPUP_T
Useoptional
Parent in.TOPUP_INFO

This indicates the when the last topup happened.

1array    GROUP_TOPUP_INFO
Useoptional
Parent in.TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

The field represents sponsored topup. The array contains fields related to Sponsored topup only.

2poid    POID
Userequired
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
Class/group/topup

The /group/topup poid. Poid of sponsored topup group involved in the creation/modification of member account. If the object instance exists, the poid is complete poid with valid poid number. If no object instance exists, the poid is type only poid.

2poid    PARENT
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
Class/account

Parent's account poid.

2string    NAME
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
Max length255

The Name of the /group/topup. This helps to identify the group.

2poid    BAL_GRP_OBJ
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
Class/balance_group

Balance Group of the parent/payer of the /group/topup.

2array    GROUP_TOPUP_LIMITS
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

Represents /group/topup financial properties per resource id.

3int    RESOURCE_ID
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Resource id of topup operation

3decimal    TOPUP_AMT
Userequired
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup amount is used in automatic sponsored topup.

3decimal    TOPUP_CAP
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup cap is used as a maximum limit of topup for particular topup group during cycle.

2array    GROUP_TOPUP_MEMBERS
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

Represents members' properties of the /group/topup.

3poid    BAL_GRP_OBJ
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
Class/balance_group

Balance Group of a member of the /group/topup.

3int    TOPUP_INTERVAL
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

This indicates the interval at which automatic sponsored topup occur.

3string    PIN
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
Max length60

The PIN which will be used for authentication during Ad-Hoc topup.

3enum    STATUS
Useoptional
Parent in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

10100Indicates an active member(PIN_STATUS_ACTIVE).
10102Indicates an inactive member(PIN_STATUS_INACTIVE).
10103Indicates a closed member(PIN_STATUS_CLOSED).
The status of the member (active/inactive/closed).

0substruct    CONTEXT_INFO
Useoptional

Substruct to pass information from external clients.

1string    CORRELATION_ID
Useoptional
Parent in.CONTEXT_INFO
Max length128

Correlation id passed by an external system to Oracle Monetization Cloud.

1string    EXTERNAL_USER
Useoptional
Parent in.CONTEXT_INFO
Max length128

User of an external system connecting to Oracle Monetization Cloud.


Output details

0poid    POID
Userequired
Class/plan
Class/account

Poid of the plan or account passed in.

0poid    ACCOUNT_OBJ
Useoptional
Class/account

Poid of the modified account object.

0timestamp    END_T
Useoptional

This field represents the timestamp at which the event ends. Effective time of the update to this account, on an external system. If not specified, the current time on the Oracle Monetization Cloud server will be used.

0timestamp    START_T
Useoptional

This would be the timestamp to be used to generate events. If not specified, the current time on the Oracle Monetization Cloud server will be used.

0string    PROGRAM_NAME
Useoptional
Max length60

The name of the program that executed this operation.

0array    ACCTINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements1
Allow ELEMID_ANYfalse

Information to be stored in the account object that was passed in.

1poid    POID
Userequired
Parent out.ACCTINFO
Class/account

Account poid.

1poid    DEAL_OBJ
Useoptional
Parent out.ACCTINFO
Class/deal

Account level deal purchased (if any).

1substruct    DEAL_INFO
Useoptional
Parent out.ACCTINFO
Recursivefalse

Deal purchased at account level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

2string    NAME
Useoptional
Parent out.ACCTINFO.DEAL_INFO
Max length255

Name of the object. Present only if a customized deal is to be purchased.

2string    DESCR
Useoptional
Parent out.ACCTINFO.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

2timestamp    START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

2timestamp    END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

2int    FLAGS
Useoptional
Parent out.ACCTINFO.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

2array    PRODUCTS
Useoptional
Parent out.ACCTINFO.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

3poid    PRODUCT_OBJ
Userequired
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

3poid    PLAN_OBJ
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

3poid    OFFERING_OBJ
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS
Class/purchased_product

Poid of purchased product.

3int    PACKAGE_ID
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

3decimal    QUANTITY
Userequired
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

3timestamp    PURCHASE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

3int    PURCHASE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3decimal    PURCHASE_DISCOUNT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_DISC_AMT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_FEE_AMT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

3timestamp    CYCLE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

3decimal    CYCLE_DISCOUNT
Userequired
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

3decimal    CYCLE_DISC_AMT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

3decimal    CYCLE_FEE_AMT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

3timestamp    USAGE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

3decimal    USAGE_DISCOUNT
Userequired
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

3string    DESCR
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

3string    PRICE_LIST_NAME
Useoptional
Parent out.ACCTINFO.DEAL_INFO.PRODUCTS
Max length255

Price list name associated with this offering.

2array    DISCOUNTS
Useoptional
Parent out.ACCTINFO.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

3poid    DISCOUNT_OBJ
Userequired
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

3poid    PLAN_OBJ
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

3poid    OFFERING_OBJ
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS
Class/purchased_discount

Poid of purchased discount.

3int    PACKAGE_ID
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

3decimal    QUANTITY
Userequired
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For later use.

3timestamp    PURCHASE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

3int    PURCHASE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3timestamp    CYCLE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

3timestamp    USAGE_START_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

3string    DESCR
Useoptional
Parent out.ACCTINFO.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

2array    PERMITTEDS
Useoptional
Parent out.ACCTINFO.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

3string    OBJ_TYPE
Userequired
Parent out.ACCTINFO.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    BAL_INFO
Useoptional
Parent out.ACCTINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

Account level balance group indicator. Here the array does not contain anything but the element-id is significant. It indicates which balance group element in the input is account level. It is recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a default balance group will be created.

2poid    POID
Userequired
Parent out.ACCTINFO.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

2string    NAME
Useoptional
Parent out.ACCTINFO.BAL_INFO
Max length255

Balance Group name.

2array    BILLINFO
Useoptional
Parent out.ACCTINFO.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    POID
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

3poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

3string    BILLINFO_ID
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

3array    PAYINFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

4poid    POID
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

4enum    PAY_TYPE
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

4enum    PAYMENT_TERM
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

4int    PAYMENT_OFFSET
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

4string    NAME
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO


4enum    INV_TYPE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

4int    FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

4substruct    INHERITED_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

5array    INV_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

6string    CITY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

6string    DELIVERY_DESCR
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

6enum    DELIVERY_PREFER
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

6string    INV_INSTR
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

6enum    INV_TERMS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

6string    EMAIL_ADDR
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

6string    NAME
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

6string    STATE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

5array    CC_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

6string    CITY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

6string    DEBIT_EXP
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

6string    DEBIT_NUM
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

6string    NAME
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

6string    SECURITY_ID
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

6string    STATE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

5array    DD_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

6string    BANK_NO
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

6string    CITY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

6string    DEBIT_NUM
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

6string    NAME
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

6string    STATE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

6enum    TYPE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

6string    ZIP
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

5array    SEPA_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

6enum    MANDATE_TYPE
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

6string    IBAN
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

6string    BIC
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

6string    MANDATE_CONTRACT_ID
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

6string    MANDATE_CONTRACT_DESCR
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

6string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

6timestamp    MANDATE_SIGNED_T
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

6string    MANDATE_SIGNED_PLACE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

6array    DEBTOR_INFO
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

7string    ADDRESS
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

7string    CITY
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

7string    COUNTRY
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

7string    NAME
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

7string    ZIP
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

7string    IDENTIFICATION_CODE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

7string    REF_PARTY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

7string    REF_PARTY_ID_CODE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

6string    CREDITOR_ID
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

6string    CREDITOR_NAME
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

3array    BAL_INFO
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3enum    PAY_TYPE
Userequired
Parent out.ACCTINFO.BAL_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

3int    PARENT_FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

3int    BILL_WHEN
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

Anniversary billing slot.

3int    ACTG_FUTURE_DOM
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

3enum    ACTG_TYPE
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

3enum    BILLING_STATUS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

3int    BILLING_STATUS_FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

3enum    STATUS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

3int    STATUS_FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

3int    SPONSOR_FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

3int    SPONSOREE_FLAGS
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

3poid    AR_BILLINFO_OBJ
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

3poid    PARENT_BILLINFO_OBJ
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

3int    CURRENCY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3int    CURRENCY_SECONDARY
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3enum    BILLING_SEGMENT
Useoptional
Parent out.ACCTINFO.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

2poid    BILLINFO_OBJ
Useoptional
Parent out.ACCTINFO.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

2array    LIMIT
Useoptional
Parent out.ACCTINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

3decimal    CREDIT_LIMIT
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3decimal    CREDIT_FLOOR
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

3decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3int    CREDIT_THRESHOLDS
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

3array    THRESHOLDS
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

4int    THRESHOLD
Userequired
Parent out.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

4decimal    AMOUNT
Useoptional
Parent out.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

2array    RULES
Useoptional
Parent out.ACCTINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

3enum    CONSUMPTION_RULE
Useoptional
Parent out.ACCTINFO.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

1poid    BAL_GRP_OBJ
Useoptional
Parent out.ACCTINFO
Class/balance_group

The balance group object for the account. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified.

1int    CURRENCY
Userequired
Parent out.ACCTINFO

This is the primary currency of the account. This acts as element-id of primary balance element for accounting roll-up. If not provided the default account currency information will be read from CM's pin.conf.

1int    CURRENCY_SECONDARY
Userequired
Parent out.ACCTINFO

The secondary currency of the account. Also this acts as element-id of secondary balance element for accounting roll-up.

0array    SERVICES
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

This represents services array.

1poid    SERVICE_OBJ
Userequired
Parent out.SERVICES
Class/service

The poid of service object created.

1int    SUBSCRIPTION_INDEX
Useoptional
Parent out.SERVICES

If this is a member service of a line/subscription, the index points to the parent/subscription service of the line. The member service object, when created, will refer the parent/subscription service using the SUBSCRIPTION_OBJ field. For all other services, the default is 0.

1poid    SUBSCRIPTION_OBJ
Useoptional
Parent out.SERVICES
Class/service

Subscription service object POID. This is an optional field, and it refers to the subscription service object of which this service is a member of.

1poid    BILLINFO_OBJ
Useoptional
Parent out.SERVICES
Class/billinfo

The billinfo object that this service belongs to.

1string    SERVICE_ID
Useoptional
Parent out.SERVICES
Max length255

User defined name for the service. This identifies the service uniquely within the plan.

1array    BAL_INFO
Useoptional
Parent out.SERVICES
ElemID modekey
Min number of Elements0
Max number of Elements1

Balance Group array which this service instance is associated to. The element-id is significant not the contents of the array. The element-id will be used to identify which balance group array to use from the input to associate the service to. if not specified the service will be associated with the account level balance group.

2poid    POID
Userequired
Parent out.SERVICES.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

2string    NAME
Useoptional
Parent out.SERVICES.BAL_INFO
Max length255

Balance Group name.

2array    BILLINFO
Useoptional
Parent out.SERVICES.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    POID
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

3poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

3string    BILLINFO_ID
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

3array    PAYINFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

4poid    POID
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

4enum    PAY_TYPE
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

4enum    PAYMENT_TERM
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

4int    PAYMENT_OFFSET
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

4string    NAME
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO


4enum    INV_TYPE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

4int    FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

4substruct    INHERITED_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

5array    INV_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

6string    CITY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

6string    DELIVERY_DESCR
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

6enum    DELIVERY_PREFER
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

6string    INV_INSTR
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

6enum    INV_TERMS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

6string    EMAIL_ADDR
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

6string    NAME
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

6string    STATE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

5array    CC_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

6string    CITY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

6string    DEBIT_EXP
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

6string    DEBIT_NUM
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

6string    NAME
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

6string    SECURITY_ID
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

6string    STATE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

6string    ZIP
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

5array    DD_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

6string    ADDRESS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

6string    BANK_NO
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

6string    CITY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

6string    COUNTRY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

6string    DEBIT_NUM
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

6string    NAME
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

6string    STATE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

6enum    TYPE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

6string    ZIP
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

5array    SEPA_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

6enum    MANDATE_TYPE
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

6string    IBAN
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

6string    BIC
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

6string    MANDATE_CONTRACT_ID
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

6string    MANDATE_CONTRACT_DESCR
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

6string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

6timestamp    MANDATE_SIGNED_T
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

6string    MANDATE_SIGNED_PLACE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

6array    DEBTOR_INFO
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

7string    ADDRESS
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

7string    CITY
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

7string    COUNTRY
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

7string    NAME
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

7string    ZIP
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

7string    IDENTIFICATION_CODE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

7string    REF_PARTY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

7string    REF_PARTY_ID_CODE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

6string    CREDITOR_ID
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

6string    CREDITOR_NAME
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

3array    BAL_INFO
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3enum    PAY_TYPE
Userequired
Parent out.SERVICES.BAL_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

3int    PARENT_FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

3int    BILL_WHEN
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

Anniversary billing slot.

3int    ACTG_FUTURE_DOM
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

3enum    ACTG_TYPE
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

3enum    BILLING_STATUS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

3int    BILLING_STATUS_FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

3enum    STATUS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

3int    STATUS_FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

3int    SPONSOR_FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

3int    SPONSOREE_FLAGS
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

3poid    AR_BILLINFO_OBJ
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

3poid    PARENT_BILLINFO_OBJ
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

3int    CURRENCY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3int    CURRENCY_SECONDARY
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

3enum    BILLING_SEGMENT
Useoptional
Parent out.SERVICES.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

2poid    BILLINFO_OBJ
Useoptional
Parent out.SERVICES.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

2array    LIMIT
Useoptional
Parent out.SERVICES.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

3decimal    CREDIT_LIMIT
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3decimal    CREDIT_FLOOR
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

3decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

3int    CREDIT_THRESHOLDS
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

3array    THRESHOLDS
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

4int    THRESHOLD
Userequired
Parent out.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

4decimal    AMOUNT
Useoptional
Parent out.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

2array    RULES
Useoptional
Parent out.SERVICES.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

3enum    CONSUMPTION_RULE
Useoptional
Parent out.SERVICES.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

1poid    BAL_GRP_OBJ
Useoptional
Parent out.SERVICES
Class/balance_group

The balance group object for the service. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

1string    LOGIN
Useoptional
Parent out.SERVICES
Max length255

Login for service object.

1array    ALIAS_LIST
Useoptional
Parent out.SERVICES
ElemID modeindex
Min number of Elements0

The array of new aliases.

2string    NAME
Useoptional
Parent out.SERVICES.ALIAS_LIST
Max length128

The alias.

1enum    PASSWD_STATUS
Useoptional
Parent out.SERVICES

0The password status is valid and normal (PIN_SERV_PASSWDSTATUS_NORMAL).
1The password status is valid and is temporary (PIN_SERV_PASSWDSTATUS_TEMPORARY).
2The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES).
3The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID).
Desired password status. The possible values are NORMAL(0), TEMP(1), EXPIRES(2), INVALID(3).

1poid    DEAL_OBJ
Useoptional
Parent out.SERVICES
Class/deal

Deal that service object purchased (if any). This is for backward compatibility for the Plan not having PIN_FLD_DEALS array.

1substruct    DEAL_INFO
Useoptional
Parent out.SERVICES
Recursivefalse

Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

2string    NAME
Useoptional
Parent out.SERVICES.DEAL_INFO
Max length255

Name of the object. Present only if a customized deal is to be purchased.

2string    DESCR
Useoptional
Parent out.SERVICES.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

2timestamp    START_T
Useoptional
Parent out.SERVICES.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

2timestamp    END_T
Useoptional
Parent out.SERVICES.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

2int    FLAGS
Useoptional
Parent out.SERVICES.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

2array    PRODUCTS
Useoptional
Parent out.SERVICES.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

3poid    PRODUCT_OBJ
Userequired
Parent out.SERVICES.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

3poid    PLAN_OBJ
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

3poid    OFFERING_OBJ
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS
Class/purchased_product

Poid of purchased product.

3int    PACKAGE_ID
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

3decimal    QUANTITY
Userequired
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent out.SERVICES.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

3timestamp    PURCHASE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

3int    PURCHASE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3decimal    PURCHASE_DISCOUNT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_DISC_AMT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

3decimal    PURCHASE_FEE_AMT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

3timestamp    CYCLE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

3decimal    CYCLE_DISCOUNT
Userequired
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

3decimal    CYCLE_DISC_AMT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

3decimal    CYCLE_FEE_AMT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

3timestamp    USAGE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

3decimal    USAGE_DISCOUNT
Userequired
Parent out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

3string    DESCR
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

3string    PRICE_LIST_NAME
Useoptional
Parent out.SERVICES.DEAL_INFO.PRODUCTS
Max length255

Price list name associated with this offering.

2array    DISCOUNTS
Useoptional
Parent out.SERVICES.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

3poid    DISCOUNT_OBJ
Userequired
Parent out.SERVICES.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

3poid    PLAN_OBJ
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

3poid    OFFERING_OBJ
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS
Class/purchased_discount

Poid of purchased discount.

3int    PACKAGE_ID
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

3decimal    QUANTITY
Userequired
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Quantity to purchase.

3enum    STATUS
Userequired
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

3int    STATUS_FLAGS
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For later use.

3timestamp    PURCHASE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

3int    PURCHASE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

3timestamp    PURCHASE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

3int    PURCHASE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    PURCHASE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

3timestamp    CYCLE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

3int    CYCLE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

3timestamp    CYCLE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

3int    CYCLE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    CYCLE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

3timestamp    USAGE_START_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

3int    USAGE_START_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_START_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

3timestamp    USAGE_END_T
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

3int    USAGE_END_UNIT
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

3int    USAGE_END_OFFSET
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

3string    DESCR
Useoptional
Parent out.SERVICES.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

2array    PERMITTEDS
Useoptional
Parent out.SERVICES.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

3string    OBJ_TYPE
Userequired
Parent out.SERVICES.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    DEALS
Useoptional
Parent out.SERVICES
ElemID modeignored
Iterationundefined
Min number of Elements0

This is the array of deals that this service purchases.

2poid    DEAL_OBJ
Useoptional
Parent out.SERVICES.DEALS
Class/deal

It indicates the deal poid that will be purchased without customization.

2enum    TYPE
Useoptional
Parent out.SERVICES.DEALS

0PIN_PRICE_DEAL_OPTIONAL
1PIN_PRICE_DEAL_REQUIRED
Deal option type. Required only if a valid service id is provided.

2substruct    DEAL_INFO
Useoptional
Parent out.SERVICES.DEALS
Recursivefalse

Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

3string    NAME
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO
Max length255

Name of the object. Present only if a customized deal is to be purchased.

3string    DESCR
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO
Max length255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

3timestamp    START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

3timestamp    END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

3int    FLAGS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

3array    PRODUCTS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO
ElemID modeignored
Iterationundefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

4poid    PRODUCT_OBJ
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Class/product

Poid of the product to purchase.

4poid    PLAN_OBJ
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Class/plan

Poid of plan through which product is being purchased.

4poid    OFFERING_OBJ
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Class/purchased_product

Poid of purchased product.

4int    PACKAGE_ID
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

4decimal    QUANTITY
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Quantity to purchase.

4enum    STATUS
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

4int    STATUS_FLAGS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

4timestamp    PURCHASE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

4int    PURCHASE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

4timestamp    PURCHASE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

4int    PURCHASE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

4decimal    PURCHASE_DISCOUNT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

4decimal    PURCHASE_DISC_AMT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

4decimal    PURCHASE_FEE_AMT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

4timestamp    CYCLE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

4int    CYCLE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

4timestamp    CYCLE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

4int    CYCLE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

4decimal    CYCLE_DISCOUNT
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

4decimal    CYCLE_DISC_AMT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

4decimal    CYCLE_FEE_AMT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

4timestamp    USAGE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

4int    USAGE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

4timestamp    USAGE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

4int    USAGE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

4decimal    USAGE_DISCOUNT
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

4string    DESCR
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Max length255

Description on a per product basis for CSR to add comments.

4string    PRICE_LIST_NAME
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
Max length255

Price list name associated with this offering.

3array    DISCOUNTS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO
ElemID modeignored
Iterationundefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

4poid    DISCOUNT_OBJ
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Class/discount

Poid of discount to purchase.

4poid    PLAN_OBJ
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Class/plan

Poid of plan through which discount is being purchased.

4poid    OFFERING_OBJ
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Class/purchased_discount

Poid of purchased discount.

4int    PACKAGE_ID
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

4decimal    QUANTITY
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Quantity to purchase.

4enum    STATUS
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

0NOT_SET
1ACTIVE
2INACTIVE
3CANCELLED
Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

4int    STATUS_FLAGS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For later use.

4timestamp    PURCHASE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

4int    PURCHASE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

4timestamp    PURCHASE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

4int    PURCHASE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    PURCHASE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

4timestamp    CYCLE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

4int    CYCLE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

4timestamp    CYCLE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

4int    CYCLE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    CYCLE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

4timestamp    USAGE_START_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

4int    USAGE_START_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_START_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

4timestamp    USAGE_END_T
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

4int    USAGE_END_UNIT
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

4int    USAGE_END_OFFSET
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

4string    DESCR
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
Max length255

Description on a per discount basis for CSR to add comments.

3array    PERMITTEDS
Useoptional
Parent out.SERVICES.DEALS.DEAL_INFO
ElemID modeignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

4string    OBJ_TYPE
Userequired
Parent out.SERVICES.DEALS.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

1array    STATUSES
Useoptional
Parent out.SERVICES
Min number of Elements0
Max number of Elements1

Desired Status Info - if not specified, an active service is created. The element-id is not significant.

2enum    STATUS
Userequired
Parent out.SERVICES.STATUSES

10100Indicates an active service(PIN_STATUS_ACTIVE).
10102Indicates an inactive service(PIN_STATUS_INACTIVE).
10103Indicates a closed service(PIN_STATUS_CLOSED).
Desired status of the service. The possible values of this field would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).

2int    STATUS_FLAGS
Userequired
Parent out.SERVICES.STATUSES

Desired status flags. This indicates a reason for this service to become inactive or closed.

2timestamp    CLOSE_WHEN_T
Useoptional
Parent out.SERVICES.STATUSES

Desired service close time.

1array    PROFILES
Useoptional
Parent out.SERVICES
ElemID modeignored
Iterationundefined
Min number of Elements0

Profiles associate with this service.

2poid    PROFILE_OBJ
Userequired
Parent out.SERVICES.PROFILES
Class/profile

The poid of the profile object created.

2substruct    INHERITED_INFO
Useoptional
Parent out.SERVICES.PROFILES

Inherited info for profile object.

1substruct    INHERITED_INFO
Useoptional
Parent out.SERVICES

Inherited info for service object.

1array    DEVICES
Useoptional
Parent out.SERVICES
Min number of Elements0

Devices array. This contains an array of device poids to be associated with the service being created.

2poid    DEVICE_OBJ
Userequired
Parent out.SERVICES.DEVICES
Class/device

Poid of the device that is associated.

0array    BILLINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements0

This represents the array of Billing info's specified.

1poid    POID
Userequired
Parent out.BILLINFO
Class/billinfo

The POID of billinfo

1poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent out.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

1string    BILLINFO_ID
Useoptional
Parent out.BILLINFO
Max length60

This field identifies the billinfo by name.

1int    ACTG_CYCLE_DOM
Useoptional
Parent out.BILLINFO

Billing date

1poid    PAYINFO_OBJ
Useoptional
Parent out.BILLINFO
Class/payinfo

The payinfo object that this billinfo is associated with.

1poid    BAL_GRP_OBJ
Useoptional
Parent out.BILLINFO
Class/balance_group

The balance group object that this billinfo is associated with.

1int    FLAGS
Useoptional
Parent out.BILLINFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

1enum    PAY_TYPE
Userequired
Parent out.BILLINFO

0Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
This represents the type of billing for user.

1int    PARENT_FLAGS
Useoptional
Parent out.BILLINFO

Indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates. A value of 1 indicates that it has subordinates.

1int    BILL_WHEN
Useoptional
Parent out.BILLINFO

Anniversary billing slot.

1int    ACTG_FUTURE_DOM
Useoptional
Parent out.BILLINFO

New Accounting Close day-of-month (1-31).

1enum    ACTG_TYPE
Useoptional
Parent out.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

1enum    BILLING_STATUS
Useoptional
Parent out.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

1int    BILLING_STATUS_FLAGS
Useoptional
Parent out.BILLINFO

Indicates a reason for setting of the given billing status.

1enum    STATUS
Useoptional
Parent out.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

1int    STATUS_FLAGS
Useoptional
Parent out.BILLINFO

It indicates a reason for setting of the given status.

1int    SPONSOR_FLAGS
Useoptional
Parent out.BILLINFO

It indicates whether this billinfo has a sponsoree.

1int    SPONSOREE_FLAGS
Useoptional
Parent out.BILLINFO

It indicates whether this billinfo has a sponsor.

1poid    AR_BILLINFO_OBJ
Useoptional
Parent out.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

1poid    PARENT_BILLINFO_OBJ
Useoptional
Parent out.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

1int    CURRENCY
Useoptional
Parent out.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

1int    CURRENCY_SECONDARY
Useoptional
Parent out.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

1enum    BILLING_SEGMENT
Useoptional
Parent out.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

1timestamp    EFFECTIVE_T
Useoptional
Parent out.BILLINFO

This field represents the timestamp of effective time of the update to this billinfo. If not specified, the current time on the Oracle Monetization Cloud server will be used.

0array    BAL_INFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements0

The Balance Group array. List of balance groups that was to be created or updated in this operation.

1poid    POID
Userequired
Parent out.BAL_INFO
Class/balance_group

The balance group POID.

1string    NAME
Useoptional
Parent out.BAL_INFO
Max length255

Balance Group name.

1poid    BILLINFO_OBJ
Useoptional
Parent out.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group is associated with.

1poid    ACCOUNT_OBJ
Useoptional
Parent out.BAL_INFO
Class/account

The account object that this bal-info is associated with.

1poid    SERVICE_OBJ
Useoptional
Parent out.BAL_INFO
Class/service

The service object that this bal-info is associated with.

1array    LIMIT
Useoptional
Parent out.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

2decimal    CREDIT_LIMIT
Useoptional
Parent out.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

2decimal    CREDIT_FLOOR
Useoptional
Parent out.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

2int    CREDIT_THRESHOLDS
Useoptional
Parent out.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

2array    THRESHOLDS
Useoptional
Parent out.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

3int    THRESHOLD
Userequired
Parent out.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

1array    RULES
Useoptional
Parent out.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

2enum    CONSUMPTION_RULE
Useoptional
Parent out.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

0array    PAYINFO
Useoptional
ElemID modeindex
Iterationundefined
Min number of Elements1

Array of payment methods associated with this account.

1poid    POID
Userequired
Parent out.PAYINFO
Class/payinfo

The POID of the payinfo object created or updated.

1enum    PAY_TYPE
Userequired
Parent out.PAYINFO

0Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
This represents the type of billing for user.

1enum    PAYMENT_TERM
Useoptional
Parent out.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

1int    PAYMENT_OFFSET
Useoptional
Parent out.PAYINFO

Payment Offset.

1enum    INV_TYPE
Useoptional
Parent out.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT)
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

1int    FLAGS
Useoptional
Parent out.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

1substruct    INHERITED_INFO
Useoptional
Parent out.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

2array    INV_INFO
Useoptional
Parent out.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

3string    CITY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

3string    DELIVERY_DESCR
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

3enum    DELIVERY_PREFER
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
2Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

3string    INV_INSTR
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

3enum    INV_TERMS
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

3string    EMAIL_ADDR
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

3string    NAME
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

3string    STATE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

3string    ZIP
Useoptional
Parent out.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

2array    CC_INFO
Useoptional
Parent out.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address.

3string    CITY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

3string    DEBIT_EXP
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

3string    DEBIT_NUM
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

3string    NAME
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

3string    SECURITY_ID
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

3string    STATE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

3string    ZIP
Useoptional
Parent out.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

2array    DD_INFO
Useoptional
Parent out.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

3string    ADDRESS
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

3string    BANK_NO
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

3string    CITY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

3string    COUNTRY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

3string    DEBIT_NUM
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

3string    NAME
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

3string    STATE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

3enum    TYPE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

3string    ZIP
Useoptional
Parent out.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

2array    SEPA_INFO
Useoptional
Parent out.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment menthod. There will be only one element and element id is not significant.

3enum    MANDATE_TYPE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

3string    IBAN
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

3string    BIC
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

3string    MANDATE_CONTRACT_ID
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

3string    MANDATE_CONTRACT_DESCR
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

3string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

3array    DEBTOR_INFO
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

4string    ADDRESS
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

4string    CITY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

4string    COUNTRY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

4string    NAME
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

4string    ZIP
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

4string    IDENTIFICATION_CODE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

4string    REF_PARTY
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

4string    REF_PARTY_ID_CODE
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

3string    CREDITOR_ID
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

3string    CREDITOR_NAME
Useoptional
Parent out.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

0array    PROFILES
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

Profile array to be associated with the account.

1poid    PROFILE_OBJ
Userequired
Parent out.PROFILES
Class/profile

The POID of profile object created or modified.

1substruct    INHERITED_INFO
Useoptional
Parent out.PROFILES
Recursivefalse

Inherited info for profile object.

0array    TOPUP_INFO
Useoptional
ElemID modeignored
Iterationundefined
Min number of Elements0

Topup array.

1poid    POID
Userequired
Parent out.TOPUP_INFO
Class/topup

Topup poid.

1poid    ACCOUNT_OBJ
Useoptional
Parent out.TOPUP_INFO
Class/account

Account poid.

1array    PAYINFO
Userequired
Parent out.TOPUP_INFO
ElemID modekey
Iterationundefined
Min number of Elements1

The elemid is significant. Contents are not significant. The element id points to the payinfo array element in the request to be used for top-up.

2poid    POID
Userequired
Parent out.TOPUP_INFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

2enum    PAY_TYPE
Userequired
Parent out.TOPUP_INFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

2enum    PAYMENT_TERM
Useoptional
Parent out.TOPUP_INFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

2int    PAYMENT_OFFSET
Useoptional
Parent out.TOPUP_INFO.PAYINFO

Payment offset value.

2string    NAME
Useoptional
Parent out.TOPUP_INFO.PAYINFO


2enum    INV_TYPE
Useoptional
Parent out.TOPUP_INFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

2int    FLAGS
Useoptional
Parent out.TOPUP_INFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

2substruct    INHERITED_INFO
Useoptional
Parent out.TOPUP_INFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

3array    INV_INFO
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

4string    CITY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

4string    DELIVERY_DESCR
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

4enum    DELIVERY_PREFER
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

4string    INV_INSTR
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

4enum    INV_TERMS
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

4string    EMAIL_ADDR
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

4string    NAME
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

4string    STATE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

3array    CC_INFO
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

4string    CITY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

4string    DEBIT_EXP
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

4string    DEBIT_NUM
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

4string    NAME
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

4string    SECURITY_ID
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

4string    STATE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

4string    ZIP
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

3array    DD_INFO
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

4string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

4string    BANK_NO
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

4string    CITY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

4string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

4string    DEBIT_NUM
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

4string    NAME
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

4string    STATE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

4enum    TYPE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

4string    ZIP
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

3array    SEPA_INFO
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

4enum    MANDATE_TYPE
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

4string    IBAN
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

4string    BIC
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

4string    MANDATE_CONTRACT_ID
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

4string    MANDATE_CONTRACT_DESCR
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

4string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

4timestamp    MANDATE_SIGNED_T
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

4string    MANDATE_SIGNED_PLACE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

4array    DEBTOR_INFO
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

5string    ADDRESS
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

5string    CITY
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

5string    COUNTRY
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

5string    NAME
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

5string    ZIP
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

5string    IDENTIFICATION_CODE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

5string    REF_PARTY
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

5string    REF_PARTY_ID_CODE
Useoptional
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

4string    CREDITOR_ID
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

4string    CREDITOR_NAME
Userequired
Parent out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

1array    BILLINFO
Userequired
Parent out.TOPUP_INFO
ElemID modekey
Iterationundefined
Min number of Elements1

The elemid is significant. Contents are not significant. The element id points to the billinfo array element in the request to be used for top-up.

2poid    POID
Userequired
Parent out.TOPUP_INFO.BILLINFO
Modetypeonly
Class/billinfo

The type only billinfo poid.

2poid    BUSINESS_PROFILE_OBJ
Useoptional
Parent out.TOPUP_INFO.BILLINFO
Class/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

2string    BILLINFO_ID
Userequired
Parent out.TOPUP_INFO.BILLINFO
Max length60

This field identifies the billinfo by name.

2array    PAYINFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO
ElemID modekey
Iterationundefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

3poid    POID
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO
Modetypeonly
Class/payinfo

The partial poid of payinfo.

3enum    PAY_TYPE
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).
This represents the type of billing for user.

3enum    PAYMENT_TERM
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

3int    PAYMENT_OFFSET
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO

Payment offset value.

3string    NAME
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO


3enum    INV_TYPE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO

0x01Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).
Indicates the type of invoice to be generated.

3int    FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

3substruct    INHERITED_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO
Recursivefalse

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

4array    INV_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Street address.

5string    CITY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Country.

5string    DELIVERY_DESCR
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Delivery mechanism.

5enum    DELIVERY_PREFER
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1Indicates mail delivery(PIN_INV_USP_DELIVERY).
3Indicates fax delivery(PIN_INV_FAX_DELIVERY).
Prefered delivery method email(0), postal(1) and fax(3).

5string    INV_INSTR
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length1023

Comments to appear on each invoice.

5enum    INV_TERMS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

5string    EMAIL_ADDR
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Email address to which invoice be delivered.

5string    NAME
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length255

Name of party responsible for payment.

5string    STATE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
Max length60

Zip/Postal code.

4array    CC_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Street Address

5string    CITY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Country.

5string    DEBIT_EXP
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length128

Credit card expiration date (mmyy).

5string    DEBIT_NUM
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Credit card number.

5string    NAME
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length255

Name as it appears on the credit card.

5string    SECURITY_ID
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

5string    STATE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length90

State or province.

5string    ZIP
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
Max length60

Zip/Postal code.

4array    DD_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

5string    ADDRESS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Street Address.

5string    BANK_NO
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length30

RDFI/Bank ID used for routing transactions.

5string    CITY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

City.

5string    COUNTRY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Country.

5string    DEBIT_NUM
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Customer's bank account number.

5string    NAME
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length255

Name as it appears on the card.

5string    STATE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length90

State or province.

5enum    TYPE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).
Bank account type. Checking(1), savings(2) or corporate(3).

5string    ZIP
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
Max length60

Zip/Postal code.

4array    SEPA_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

5enum    MANDATE_TYPE
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0One-off mandate.
1Recurring mandate.
Mandate type whether it is one-off or recurring.

5string    IBAN
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length34

International Bank Account Number which is a unique identifier for the bank account.

5string    BIC
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length11

Bank Identifier Code which is a unique identifier for the bank related to the account.

5string    MANDATE_CONTRACT_ID
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

ID of the underlying contract between the debtor and the creditor.

5string    MANDATE_CONTRACT_DESCR
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Description of the underlying contract between the debtor and the creditor.

5string    MANDATE_UNIQUE_REFERENCE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

A unique reference number for the mandate.

5timestamp    MANDATE_SIGNED_T
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

5string    MANDATE_SIGNED_PLACE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length35

Place where the mandate is signed.

5array    DEBTOR_INFO
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0
Max number of Elements1
Max ID0
Allowed Elem ID List0
Allow ELEMID_ASSIGN false
Allow ELEMID_ANYfalse
Recursivefalse

Array to store SEPA compliant customer's bank account details.

6string    ADDRESS
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Street address of the contact.

6string    CITY
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length90

City portion of the address.

6string    COUNTRY
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Country portion of the address.

6string    NAME
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the contact.

6string    ZIP
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length60

Zipcode.

6string    IDENTIFICATION_CODE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Debtor identification code.

6string    REF_PARTY
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Name of the Debtor Reference Party.

6string    REF_PARTY_ID_CODE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
Max length255

Identification code of the Debtor Reference Party.

5string    CREDITOR_ID
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Identification code of the Creditor.

5string    CREDITOR_NAME
Userequired
Parent out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
Max length255

Name of the Creditor.

2array    BAL_INFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO
ElemID modekey
Iterationundefined
Min number of Elements0
Max number of Elements1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

3poid    POID
Userequired
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
Modetypeonly
Class/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

3string    NAME
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
Max length255

Balance Group name.

3array    BILLINFO
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modekey
Iterationundefined
Min number of Elements0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

3poid    BILLINFO_OBJ
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
Class/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

3array    LIMIT
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

4decimal    CREDIT_LIMIT
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

4decimal    CREDIT_FLOOR
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

4decimal    CREDIT_THRESHOLDS_FIXED
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

4int    CREDIT_THRESHOLDS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

4array    THRESHOLDS
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT
ElemID modeignored
Iterationundefined
Allow ELEMID_ASSIGN true
Allow ELEMID_ANYtrue
Recursivefalse

Array of fixed threshold values.

5int    THRESHOLD
Userequired
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

5decimal    AMOUNT
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

3array    RULES
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO
ElemID modeindex
Iterationundefined
Min number of Elements0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

4enum    CONSUMPTION_RULE
Useoptional
Parent out.TOPUP_INFO.BILLINFO.BAL_INFO.RULES

0The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).
Consumption rule to be applied on the resource.

2enum    PAY_TYPE
Userequired
Parent out.TOPUP_INFO.BILLINFO

10001Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003Indicates credit card type(PIN_PAY_TYPE_CC).
10005Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101.
This represents the type of billing for user.

2int    PARENT_FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

2int    BILL_WHEN
Useoptional
Parent out.TOPUP_INFO.BILLINFO

Anniversary billing slot.

2int    ACTG_FUTURE_DOM
Useoptional
Parent out.TOPUP_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

2enum    ACTG_TYPE
Useoptional
Parent out.TOPUP_INFO.BILLINFO

1This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).
Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

2enum    BILLING_STATUS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

0Indicates billing status is active(PIN_BILL_ACTIVE).
1Indicates billing status is inactive(PIN_BILL_INACTIVE).
Indicates whether the billinfo should be billed or it should be suspended for billing.

2int    BILLING_STATUS_FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

2enum    STATUS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

10100Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103Indicates a closed billinfo(PIN_STATUS_CLOSED).
Status of the billinfo: active, inactive, or closed.

2int    STATUS_FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given status.

2int    SPONSOR_FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

2int    SPONSOREE_FLAGS
Useoptional
Parent out.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

2poid    AR_BILLINFO_OBJ
Useoptional
Parent out.TOPUP_INFO.BILLINFO
Class/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

2poid    PARENT_BILLINFO_OBJ
Useoptional
Parent out.TOPUP_INFO.BILLINFO
Class/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

2int    CURRENCY
Useoptional
Parent out.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2int    CURRENCY_SECONDARY
Useoptional
Parent out.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

2enum    BILLING_SEGMENT
Useoptional
Parent out.TOPUP_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

1poid    PAYINFO_OBJ
Useoptional
Parent out.TOPUP_INFO
Class/payinfo

The payinfo object that this topup is associated with. If PIN_FLD_PAYINFO is passed in, this field will be ignored. If PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.

1poid    BILLINFO_OBJ
Useoptional
Parent out.TOPUP_INFO
Class/billinfo

The POID of Billinfo that this topup is associated with. If PIN_FLD_BILLINFO is passed in, this field will be ignored. If PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.

1decimal    TOPUP_AMT
Userequired
Parent out.TOPUP_INFO

Topup amount. In case of auto-topups this will indicate the amount to topup with.

1decimal    TOPUP_CAP
Useoptional
Parent out.TOPUP_INFO

Topup cap. This amount indicates the max topup that can be done for a given cycle. The cycle is driven by the cycle information set-up in the billinfo. A values of 0 means no cap.

1decimal    CYCLE_TOPPED_AMT
Useoptional
Parent out.TOPUP_INFO

This indicates the total topped up amount during the given cycle. This amount will be populated only if the cap is set.

1timestamp    LAST_TOPUP_T
Useoptional
Parent out.TOPUP_INFO

This indicates the when the last topup happened.

1array    GROUP_TOPUP_INFO
Useoptional
Parent out.TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

The field represents sponsored topup. The array contains fields related to Sponsored topup only.

2poid    POID
Userequired
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
Class/group/topup

The /group/topup poid. Poid of sponsored topup group involved in the creation/modification of member account.

2poid    PARENT
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
Class/account

Parent's account poid

2string    NAME
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
Max length255

The Name of the /group/topup. This helps to identify the group.

2poid    BAL_GRP_OBJ
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
Class/balance_group

Balance Group of the parent/payer of the /group/topup

2array    GROUP_TOPUP_LIMITS
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

Represents /group/topup financial properties per resource id.

3int    RESOURCE_ID
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Resource id of topup operation.

3decimal    TOPUP_AMT
Userequired
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup amount is used in automatic sponsored topup.

3decimal    TOPUP_CAP
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup cap is used as a maximum limit of topup for particular topup group during cycle.

2array    GROUP_TOPUP_MEMBERS
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO
ElemID modeignored
Iterationundefined
Min number of Elements0

Represents members' properties of the /group/topup.

3poid    BAL_GRP_OBJ
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
Class/balance_group

Balance Group of a member of the /group/topup.

3int    TOPUP_INTERVAL
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

This indicates the interval at which automatic sponsored topup occur.

3string    PIN
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
Max length60

The PIN which will be used for authentication during Ad-Hoc topup.

3enum    STATUS
Useoptional
Parent out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

10100Indicates an active member(PIN_STATUS_ACTIVE).
10102Indicates an inactive member(PIN_STATUS_INACTIVE).
10103Indicates a closed member(PIN_STATUS_CLOSED).
The status of the member (active/inactive/closed).

0substruct    CONTEXT_INFO
Useoptional

Substruct to pass information from external clients.

1string    CORRELATION_ID
Useoptional
Parent out.CONTEXT_INFO
Max length128

Correlation id passed by an external system to Oracle Monetization Cloud.

1string    EXTERNAL_USER
Useoptional
Parent out.CONTEXT_INFO
Max length128

User of an external system connecting to Oracle Monetization Cloud.


Input indexInput detailsOutput indexOutput details